1.0.3 - release CH

KisimScheduling - Local Development build (v1.0.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Search Appointments by Encounter - JSON Representation

Draft as of 2025-07-25

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "appointment-query-searchByEncounter",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition appointment-query-searchByEncounter</b></p><a name=\"appointment-query-searchByEncounter\"> </a><a name=\"hcappointment-query-searchByEncounter\"> </a><a name=\"appointment-query-searchByEncounter-en-US\"> </a><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>_query</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td><a href=\"http://hl7.org/fhir/R4/valueset-binding-strength.html\">BindingStrength</a> (Required)</td><td><div><p>Extended search parameter, value has to be searchByEncounter</p>\n</div></td></tr><tr><td>IN</td><td>encounter</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td><a href=\"http://hl7.org/fhir/R4/valueset-binding-strength.html\">BindingStrength</a> (Required)</td><td><div><p>The encounter ID.</p>\n</div></td></tr><tr><td>IN</td><td>date</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td><a href=\"http://hl7.org/fhir/R4/valueset-binding-strength.html\">BindingStrength</a> (Required)</td><td><div><p>Time window where appointments are taking place</p>\n</div></td></tr><tr><td>IN</td><td>_lastUpdated</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td><a href=\"http://hl7.org/fhir/R4/valueset-binding-strength.html\">BindingStrength</a> (Required)</td><td><div><p>Time window in which the appointments were last updated</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td><a href=\"http://hl7.org/fhir/R4/valueset-binding-strength.html\">BindingStrength</a> (Required)</td><td><div><p>A bundle of appointment ressources.</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/appointment-query-searchByEncounter",
  "version" : "1.0.3",
  "name" : "SearchAppointmentByEncounter",
  "title" : "Search Appointments by Encounter",
  "status" : "draft",
  "kind" : "query",
  "date" : "2025-07-25T15:46:04+02:00",
  "publisher" : "Cistec AG",
  "contact" : [
    {
      "name" : "Cistec AG",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.cistec.com"
        },
        {
          "system" : "email",
          "value" : "robert.birri@cistec.com"
        }
      ]
    }
  ],
  "description" : "Search appointments for a specific encounter",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "CH"
        }
      ]
    }
  ],
  "code" : "searchByUser",
  "resource" : [
    "Appointment"
  ],
  "system" : false,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "_query",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Extended search parameter, value has to be searchByEncounter",
      "type" : "string",
      "searchType" : "string",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/binding-strength"
      }
    },
    {
      "name" : "encounter",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The encounter ID.",
      "type" : "string",
      "searchType" : "string",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/binding-strength"
      }
    },
    {
      "name" : "date",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Time window where appointments are taking place",
      "type" : "date",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/binding-strength"
      }
    },
    {
      "name" : "_lastUpdated",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Time window in which the appointments were last updated",
      "type" : "date",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/binding-strength"
      }
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "A bundle of appointment ressources.",
      "type" : "Bundle",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/binding-strength"
      }
    }
  ]
}