--- schema_version: "1" id: a2e6062084007db8703da7c750ee8452db772642e8905071fb51d113a8a87130 title: Administration collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/health/references/generated-api-specs/administration.md canonical_url: https://developer.salesforce.com/docs/industries/health/references/administration source_site: developer.salesforce.com content_type: documentation content_hash: c5937081dfe5ee76c10b0535f45d598cabec28d7d543d921548deab05549c7ad products: - Salesforce Healthcare API - Industries Integrations --- Administration # Administration Use the FHIR R4 Administration API to work with the Administration module. The Administration module includes the base data that can be linked with the other modules, such as clinical content, finance, and billing workflow. **Version:** v1 Protocols: https. ## Operations ### GET Get patient records `GET /Patient` Retrieves a set of resources by using filters. #### Parameters * `identifier` (query, string | integer) Specifies a patient's identifier. Search is performed on 'code' or 'system' and 'code' identifiers. * `name` (query, string) Specifies a server-defined search that matches the string fields in the HumanName - family and given names. * `gender` (query, string) Searches based on gender using 'code' or 'system' and 'code' identifier and must be done along with the 'name' identifier. For example - 'GET \[base\]/Patient?gender={system|}\[code\]&name=\[string\]'. * `birthdate` (query, string) Searches using the patient's date of birth and must be done along with the 'name' identifier. For example - 'GET \[base\]/Patient?birthdate=\[date\]&name=\[string\]'. * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Responses * **200** Media type: `application/fhir+json`. Schema: `PatientBundle`. _Example_ ``` { "resourceType": "Bundle", "id": "d29ec2e2-363b-4a1f-91e9-4553f016c241", "meta": { "lastUpdated": "2023-03-24T15:44:21.063+05:30" }, "type": "searchset", "total": 4, "link": [ { "relation": "self", "url": "https://localhost:8092/admin/fhir-r4/v1/Patient?identifier=20000105719994" } ], "entry": [ { "fullUrl": "https://localhost:8092/admin/fhir-r4/v1/Patient/001B000001TdJHrIAN", "search": { "mode": "match" }, "resource": { "resourceType": "Patient", "id": "001B000001TdJHrIAN", "identifier": [ { "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719994" }, { "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719990" } ], "active": true, "name": [ { "use": "official", "family": "silva", "given": [ "Peter" ], "text": "Peter silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, { "use": "official", "family": "silva", "given": [ "James" ], "text": "James silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } } ], "telecom": [ { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1974-12-25", "deceased": { "deceasedDateTime": "2023-02-10T10:40:13.000Z" }, "address": [ { "use": "home", "city": "Abc", "line": ["100 TT Apt"], "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "use": "work", "city": "Abc", "line": ["100 TT Apt"], "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "maritalStatus": { "coding": [ { "code": "A" } ] }, "contact": [ { "relationship": [ { "coding": [ { "display": "Billing contact person" } ] } ], "name": { "use": "official", "family": "silva", "given": [ "Peter" ], "text": "Peter silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, "telecom": [ { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Bengal", "postalCode": "01045", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "gender": "male" } ], "managingOrganization": { "reference": "Organization/001B000001T33YsIAJ", "type": "Organization" } } } ] } ``` * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example_ ``` { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "text": " Details not found." } } ] } ``` * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### POST Create a patient record `POST /Patient` Creates a resource using the create interaction from the FHIR resources. #### Parameters * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Patient`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example_ ``` { "recordTypeLabel": "Patient", "resourceType": "Patient", "identifier": [{ "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719994" }, { "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719990" } ], "active": true, "name": [{ "use": "official", "family": "silva", "given": ["Peter"], "text": "Peter silva", "prefix": ["Dr"], "suffix": ["Jr"], "period": { "start": "2001-05-06", "end": "2010-05-16" } } ], "telecom": [ { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1974-12-25", "deceased":{ "deceasedDateTime": "2023-02-10T10:40:13.209004Z" }, "address": [ { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "maritalStatus": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "A", "display": "Annulled" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "L", "display": "Legally Separated" }], "text": "Marriage contract has been declared null and to not have existed" }, "multipleBirth":{ "multipleBirthInteger": 2 }, "contact": [{ "relationship": [{ "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/Billing", "code": "BP", "display": "Billing details" }, { "system": "http://terminology.hl7.org/CodeSystem/Contact", "code": "CP", "display": "Contact person" }], "text": "Contact person" }], "name": { "use": "official", "family": "silva", "given": ["Peter"], "text": "Peter silva", "prefix": ["Dr"], "suffix": ["Jr"], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, "telecom": [{ "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "gender": "male", "period": { "start": "2022-01-10", "end": "2022-01-10" } }], "managingOrganization": { "reference": "Organization/001B000001SK5MLIA1", "type": "Organization" } } ``` #### Responses * **201** No match was found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Patient/123`. Media type: `application/fhir+json`. Schema: `Patient (extended)`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. Includes all fields of `Patient`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "recordTypeLabel": "Patient", "resourceType": "Patient", "identifier": [{ "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719994" }, { "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719990" } ], "active": true, "name": [{ "use": "official", "family": "silva", "given": ["Peter"], "text": "Peter silva", "prefix": ["Dr"], "suffix": ["Jr"], "period": { "start": "2001-05-06", "end": "2010-05-16" } } ], "telecom": [ { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1974-12-25", "deceased":{ "deceasedDateTime": "2023-02-10T10:40:13.209004Z" }, "address": [ { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "maritalStatus": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "A", "display": "Annulled" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "L", "display": "Legally Separated" }], "text": "Marriage contract has been declared null and to not have existed" }, "multipleBirth":{ "multipleBirthInteger": 2 }, "contact": [{ "relationship": [{ "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/Billing", "code": "BP", "display": "Billing contact person" }, { "system": "http://terminology.hl7.org/CodeSystem/Contact", "code": "CP", "display": "Contact person" }], "text": "Contact person" }], "name": { "use": "official", "family": "silva", "given": ["Peter"], "text": "Peter silva", "prefix": ["Dr"], "suffix": ["Jr"], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, "telecom": [{ "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "gender": "male", "period": { "start": "2022-01-10", "end": "2022-01-10" } }], "managingOrganization": { "reference": "Organization/001B000001SK5MLIA1", "type": "Organization" }, "id": "1672548127" } ``` * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get a patient record `GET /Patient/{id}` Retrieves the details for a particular object using the ID. This operation is performed using the read interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) #### Responses * **200** The request was successful. Media type: `application/fhir+json`. Schema: `Patient`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example_ ``` { "resourceType": "Patient", "id": "001B000001SK5SK", "identifier": [ { "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719994" }, { "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719990" } ], "active": true, "name": [ { "use": "official", "family": "silva", "given": [ "Peter" ], "text": "Peter silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } } ], "telecom": [ { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1974-12-25", "deceased": { "deceasedDateTime": "2023-02-10T10:40:13.000Z" }, "address": [ { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "maritalStatus": { "coding": [ { "code": "A" } ] }, "multipleBirth": {}, "contact": [ { "relationship": [ { "coding": [ { "display": "Billing contact person" } ] } ], "name": { "use": "official", "family": "silva", "given": [ "Peter" ], "text": "Peter silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, "telecom": [ { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "home", "city": "Abc", "line": ["4 street"], "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "gender": "male", "period": {} } ], "managingOrganization": { "reference": "Organization/001B000001SK5MLIA1", "type": "Organization" } } ``` * **404** Search ID not found. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### PUT Update a patient record `PUT /Patient/{id}` Creates a new current version of an existing resource or creates an initial version if no resource already exists for the given ID. This operation is performed using the update interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Patient`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example_ ``` { "recordTypeLabel": "Patient", "resourceType": "Patient", "id": "001B000001Uwmpk", "identifier": [{ "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719994" }, { "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719990" } ], "active": true, "name": [{ "use": "official", "family": "silva", "given": ["Peter"], "text": "Peter silva", "prefix": ["Dr"], "suffix": ["Jr"], "period": { "start": "2001-05-06", "end": "2010-05-16" } } ], "telecom": [ { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1974-12-25", "deceased":{ "deceasedDateTime": "2023-02-10T10:40:13.209004Z" }, "address": [ { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "maritalStatus": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "A", "display": "Annulled" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "L", "display": "Legally Separated" }], "text": "Marriage contract has been declared null and to not have existed" }, "multipleBirth":{ "multipleBirthInteger": 2 }, "contact": [{ "relationship": [{ "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/Billing", "code": "BP", "display": "Billing details" }, { "system": "http://terminology.hl7.org/CodeSystem/Contact", "code": "CP", "display": "Contact person" }], "text": "Contact person" }], "name": { "use": "official", "family": "silva", "given": ["Peter"], "text": "Peter silva", "prefix": ["Dr"], "suffix": ["Jr"], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, "telecom": [{ "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "gender": "male", "period": { "start": "2022-01-10", "end": "2022-01-10" } }], "managingOrganization": { "reference": "Organization/001B000001SK5MLIA1", "type": "Organization" } } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Patient/123`. Media type: `application/fhir+json`. Schema: `Patient`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example: same as PUT /Patient/{id} request._ * **201** Created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Patient/123`. Media type: `application/fhir+json`. Schema: `Patient`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example: same as PUT /Patient/{id} request._ * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get practitioner records `GET /Practitioner` Retrieves a set of resources by using filters. #### Parameters * `identifier` (query, string | integer) Specifies an practitioner's identifier. Search is performed on - a)identifier 'code' b)identifier with 'system' and 'code'. * `name` (query, string) Specifies a server-defined search that matches any of the string fields in the HumanName - family and given names. * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Responses * **200** Media type: `application/fhir+json`. Schema: `PractitionerBundle (extended)`. Includes all fields of `PractitionerBundle`. * `entry` (_array of any_) Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version-specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. Each item: Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be the Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. _Example_ ``` { "resourceType": "Bundle", "id": "c04776af-0adc-4f08-b8e1-f2a90368f2de", "meta": { "lastUpdated": "2023-02-09T15:47:19.652+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://localhost:8092/admin/fhir-r4/v1/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi%7C221900258099" } ], "entry": [ { "fullUrl": "https://localhost:8092/api/Practitioner/0cmB0000000H7pzIAC", "search": { "mode": "match" }, "resource": { "resourceType": "Practitioner", "id": "0cmB0000000H7pzIAC", "identifier": [ { "value": "221900258099", "use": "official", "system": "http://hl7.org/fhir/sid/us-npi" }, { "value": "221135438999", "use": "usual", "system": "http://hl7.org/fhir/sid/us-npi" } ], "name": [ { "family": "Sharma", "given": ["Atul"], "suffix": ["suffix"], "prefix":["Dr"], "use": "usual" } ], "active": true, "telecom": [ { "system": "phone", "value": "1234567890", "use": "work", "rank": 1, "period": { "start": "2022-01-10" } }, { "system": "phone", "value": "0123456789", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "atul.sharma34@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [ { "use": "home", "line": ["100 TT Apt"], "city": "Maharashtra", "state": "pune", "postalCode": "01645", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "use": "work", "line": ["1003 Healthcare Home"], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "birthDate": "1994-03-20", "qualification": [ { "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "BS" } ], "text": "BS", "Identifier": [ { "value": "University of Oxford", "system": "http://example.org/UniversityIdentifier" }, { "value": "UOO", "system": "http://example.org/UniversityIdentifier123" } ] }, "period": { "start": "2022-01-10", "end": "2022-01-10" }, "issuer": { "display": "University of Oxford" } }, { "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "BS" } ], "text": "BS", "Identifier": [ { "value": "MIP", "system": "http://example.org/UniversityIdentifier123" }, { "value": "mass ins of medical sciences", "system": "http://example.org/UniversityIdentifier" } ] }, "period": { "start": "2022-01-10", "end": "2022-01-10" }, "issuer": { "display": "University of Michigan" } } ] } } ] } ``` * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### POST Create a practitioner record `POST /Practitioner` Creates a resource using the create interaction from the FHIR resources. #### Parameters * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Practitioner`. _Example_ ``` { "recordTypeLabel": "Provider", "resourceType": "Practitioner", "identifier": [{ "value": "22190025801999", "use": "official", "system": "http://hl7.org/fhir/sid/us-npi" }, { "value": "22113025438999", "use": "usual", "system": "http://hl7.org/fhir/sid/us-npi" } ], "name": [{ "use": "usual", "family": "Sharma", "given": ["Atul"], "prefix": ["Dr"], "suffix": ["suffix"] } ], "active": true, "telecom": [{ "system": "phone", "value": "1234567890", "use": "work", "rank": 1, "period": { "start": "2022-01-10" } }, { "system": "phone", "value": "0123456789", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "Atul.Sharma34@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [{ "use": "home", "line": ["100 TT Apt"], "city": "Maharashtra", "state": "pune", "postalCode": "01645", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "use": "work", "line": ["1003 Healthcare Home"], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1994-03-20", "qualification": [{ "identifier": [{ "system": "http://example.org/UniversityIdentifier", "value": "University of Oxford" }, { "system": "http://example.org/UniversityIdentifier123", "value": "UOO" } ], "code": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "Bachelor of Biology" }], "text": "Bachelor of Biology" }, "period": { "start": "2022-01-10T00:00:00.000Z", "end": "2022-01-10T00:00:00.000Z" }, "issuer": { "display": "University of Oxford" } }, { "identifier": [{ "system": "http://example.org/UniversityIdentifier123", "value": "MIP" }, { "system": "http://example.org/UniversityIdentifier", "value": "mass ins of medical sciences" } ], "code": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "masters in medicine" }], "text": "masters in medicine" }, "period": { "start": "2022-01-10T00:00:00.000Z", "end": "2022-01-10T00:00:00.000Z" }, "issuer": { "display": "University of Michigan" } } ] } ``` #### Responses * **201** No match was found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Practitioner/123`. Media type: `application/fhir+json`. Schema: `Practitioner (extended)`. Includes all fields of `Practitioner`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "recordTypeLabel": "Provider", "resourceType": "Practitioner", "identifier": [ { "value": "22190025801999", "use": "official", "system": "http://hl7.org/fhir/sid/us-npi" }, { "value": "22113025438999", "use": "usual", "system": "http://hl7.org/fhir/sid/us-npi" } ], "name": [ { "use": "usual", "family": "Sharma", "given": ["Atul"], "prefix": ["Dr"], "suffix": ["suffix"] } ], "active": true, "telecom": [ { "system": "phone", "value": "1234567890", "use": "work", "rank": 1, "period": { "start": "2022-01-10" } }, { "system": "phone", "value": "0123456789", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "Atul.Sharma34@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [ { "use": "home", "line": ["100 TT Apt"], "city": "Maharashtra", "state": "pune", "postalCode": "01645", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "use": "work", "line": ["1003 Healthcare Home"], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1994-03-20", "qualification": [ { "identifier": [ { "system": "http://example.org/UniversityIdentifier", "value": "University of Oxford" }, { "system": "http://example.org/UniversityIdentifier123", "value": "UOO" } ], "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "Bachelor of Biology" } ], "text": "Bachelor of Biology" }, "period": { "start": "2022-01-10T00:00:00.000Z", "end": "2022-01-10T00:00:00.000Z" }, "issuer": { "display": "University of Oxford" } }, { "identifier": [ { "system": "http://example.org/UniversityIdentifier123", "value": "MIP" }, { "system": "http://example.org/UniversityIdentifier", "value": "mass ins of medical sciences" } ], "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "masters in medicine" } ], "text": "masters in medicine" }, "period": { "start": "2022-01-10T00:00:00.000Z", "end": "2022-01-10T00:00:00.000Z" }, "issuer": { "display": "University of Michigan" } } ], "id": "0cmRO00000002fgYAA" } ``` * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get a practitioner record `GET /Practitioner/{id}` Retrieves the details for a particular object using the ID. This operation is performed using the read interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) #### Responses * **200** The request was successful. Media type: `application/fhir+json`. Schema: `Practitioner`. _Example_ ``` { "resourceType": "Practitioner", "id": "0cmB0000000H7pzIAC", "identifier": [ { "value": "221900258099", "use": "official", "system": "http://hl7.org/fhir/sid/us-npi" }, { "value": "221135438999", "use": "usual", "system": "http://hl7.org/fhir/sid/us-npi" } ], "name": [ { "family": "Sharma", "given": ["Atul"], "suffix": ["suffix"], "prefix": ["Dr"], "use": "usual" } ], "active": true, "telecom": [ { "system": "phone", "value": "1234567890", "use": "work", "rank": 1, "period": { "start": "2022-01-10" } }, { "system": "phone", "value": "0123456789", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "atul.sharma34@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [ { "use": "home", "line": ["100 TT Apt"], "city": "Maharashtra", "state": "pune", "postalCode": "01645", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "use": "work", "line": ["1003 Healthcare Home"], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "birthDate": "1994-03-20", "qualification": [ { "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "BS" } ], "text": "BS", "Identifier": [ { "value": "University of Oxford", "system": "http://example.org/UniversityIdentifier" }, { "value": "UOO", "system": "http://example.org/UniversityIdentifier123" } ] }, "period": { "start": "2022-01-10", "end": "2022-01-10" }, "issuer": { "display": "University of Oxford" } }, { "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "BS" } ], "text": "BS", "Identifier": [ { "value": "MIP", "system": "http://example.org/UniversityIdentifier123" }, { "value": "mass ins of medical sciences", "system": "http://example.org/UniversityIdentifier" } ] }, "period": { "start": "2022-01-10", "end": "2022-01-10" }, "issuer": { "display": "University of Michigan" } } ] } ``` * **404** Search ID not found. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### PUT Update a practitioner record `PUT /Practitioner/{id}` Creates a new current version of an existing resource or creates an initial version if no resource already exists for the given ID. This operation is performed using the update interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Practitioner`. _Example_ ``` { "recordTypeLabel": "Provider", "resourceType": "Practitioner", "id": "0cmRO00000002fgYAA", "identifier": [{ "value": "22190025801999", "use": "official", "system": "http://hl7.org/fhir/sid/us-npi" }, { "value": "22113025438999", "use": "usual", "system": "http://hl7.org/fhir/sid/us-npi" } ], "name": [{ "use": "usual", "family": "Sharma", "given": ["Arun"], "prefix": ["Dr"], "suffix": ["suffix"] } ], "active": true, "telecom": [{ "system": "phone", "value": "1234567890", "use": "work", "rank": 1, "period": { "start": "2022-01-10" } }, { "system": "phone", "value": "0123456789", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "Atul.Sharma34@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [{ "use": "home", "line": ["100 TT Apt"], "city": "Maharashtra", "state": "pune", "postalCode": "01645", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "use": "work", "line": ["1003 Healthcare Home"], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1994-03-20", "qualification": [{ "identifier": [{ "system": "http://example.org/UniversityIdentifier", "value": "University of Oxford" }, { "system": "http://example.org/UniversityIdentifier123", "value": "UOO" } ], "code": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "Bachelor of Biology" }], "text": "Bachelor of Biology" }, "period": { "start": "2022-01-10T00:00:00.000Z", "end": "2022-01-10T00:00:00.000Z" }, "issuer": { "display": "University of Oxford" } }, { "identifier": [{ "system": "http://example.org/UniversityIdentifier123", "value": "MIP" }, { "system": "http://example.org/UniversityIdentifier", "value": "mass ins of medical sciences" } ], "code": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "masters in medicine" }], "text": "masters in medicine" }, "period": { "start": "2022-01-10T00:00:00.000Z", "end": "2022-01-10T00:00:00.000Z" }, "issuer": { "display": "University of Michigan" } } ] } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Practitioner/123`. Media type: `application/fhir+json`. Schema: `Practitioner`. _Example_ ``` { "recordTypeLabel": "Provider", "resourceType": "Practitioner", "identifier": [ { "value": "22190025801999", "use": "official", "system": "http://hl7.org/fhir/sid/us-npi" }, { "value": "22113025438999", "use": "usual", "system": "http://hl7.org/fhir/sid/us-npi" } ], "name": [ { "use": "usual", "family": "Sharma", "given": ["Arun"], "prefix": ["Dr"], "suffix": ["suffix"] } ], "active": true, "telecom": [ { "system": "phone", "value": "1234567890", "use": "work", "rank": 1, "period": { "start": "2022-01-10" } }, { "system": "phone", "value": "0123456789", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "Atul.Sharma34@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [ { "use": "home", "line": ["100 TT Apt"], "city": "Maharashtra", "state": "pune", "postalCode": "01645", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "use": "work", "line": ["1003 Healthcare Home"], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1994-03-20", "qualification": [ { "identifier": [ { "system": "http://example.org/UniversityIdentifier", "value": "University of Oxford" }, { "system": "http://example.org/UniversityIdentifier123", "value": "UOO" } ], "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "Bachelor of Biology" } ], "text": "Bachelor of Biology" }, "period": { "start": "2022-01-10T00:00:00.000Z", "end": "2022-01-10T00:00:00.000Z" }, "issuer": { "display": "University of Oxford" } }, { "identifier": [ { "system": "http://example.org/UniversityIdentifier123", "value": "MIP" }, { "system": "http://example.org/UniversityIdentifier", "value": "mass ins of medical sciences" } ], "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7", "code": "BS", "display": "masters in medicine" } ], "text": "masters in medicine" }, "period": { "start": "2022-01-10T00:00:00.000Z", "end": "2022-01-10T00:00:00.000Z" }, "issuer": { "display": "University of Michigan" } } ], "id": "0cmRO00000002fgYAA" } ``` * **201** Created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Practitioner/123`. Media type: `application/fhir+json`. Schema: `Practitioner`. _Example: same as PUT /Practitioner/{id} 200 response._ * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get practitioner roles `GET /PractitionerRole` Retrieves a set of resources by using filters. #### Parameters * `identifier` (query, string | integer) Specifies a practitioner's identifier. Search is performed on 'practitioner.identifier' with 'system and code' or only 'code' identifier. * `specialty` (query, string) Specifies the practitioner's specialty at an organization. Search is performed on 'code' identifier. * `practitioner` (query, string) Specifies a practitioner's Salesforce ID. Search is performed on 'practitioner.reference'. * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Responses * **200** Media type: `application/fhir+json`. Schema: `PractitionerRoleBundle (extended)`. Includes all fields of `PractitionerRoleBundle`. * `entry` (_array of any_) Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version-specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. Each item: Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be the Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. _Example_ ``` { "resourceType": "Bundle", "id": "9200d4e0-e677-4241-86c3-3300a02a95f6", "meta": { "lastUpdated": "2023-02-14T18:16:34.668+05:30" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "http://localhost:8081/admin/fhir-r4/v1/PractitionerRole?practitioner.identifier=http://www.acme.org/practitioners%7C444" } ], "entry": [ { "fullUrl": "http://localhost:8081/api/PractitionerRole/0bSRO00000001fk2AA", "search": { "mode": "match" }, "resource": { "resourceType": "PractitionerRole", "id": "0bSRO00000001fk2AA", "identifier": [ { "use": "usual", "system": "http://www.acme.org/practitioners", "value": "444" }, { "use": "official", "system": "http://www.acme.org/practitioners", "value": "456" } ], "active": true, "period": { "start": "2012-01-01", "end": "2012-03-31" }, "practitioner": { "reference": "Practitioner/0cmRO00000002fgYAA", "display": "Dr Adam Careful" }, "organization": { "reference": "Organization/001RO000004RC9LYAW" }, "code": [ { "coding": [ { "code": "RP" } ] }, { "coding": [ { "code": "RP" } ] } ], "specialty": [ { "coding": [ { "code": "408478003" } ] }, { "coding": [ { "code": "394812008" } ] } ], "location": [ { "reference": "Location/0klRO000000000uYAA" } ], "availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break." } }, { "fullUrl": "http://localhost:8081/api/PractitionerRole/0bSRO00000001fp2AA", "search": { "mode": "match" }, "resource": { "resourceType": "PractitionerRole", "id": "0bSRO00000001fp2AA", "identifier": [ { "use": "usual", "system": "http://www.acme.org/practitioners", "value": "444" }, { "use": "official", "system": "http://www.acme.org/practitioners", "value": "456" } ], "active": true, "period": { "start": "2012-01-01", "end": "2012-03-31" }, "practitioner": { "reference": "Practitioner/0cmRO00000002fgYAA", "display": "Dr Adam Careful" }, "organization": { "reference": "Organization/001RO000004RC9LYAW" }, "code": [ { "coding": [ { "code": "RP" } ] }, { "coding": [ { "code": "RP" } ] } ], "specialty": [ { "coding": [ { "code": "408478003" } ] }, { "coding": [ { "code": "394812008" } ] } ], "location": [ { "reference": "Location/0klRO000000000uYAA" } ], "availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break." } } ] } ``` * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### POST Create a practitioner role `POST /PractitionerRole` Creates a resource using the create interaction from the FHIR resources. #### Parameters * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `PractitionerRole`. _Example_ ``` { "resourceType": "PractitionerRole", "identifier": [ { "use": "usual", "system": "http://www.acme.org/practitioners", "value": "12345" }, { "use": "official", "system": "http://www.acme.org/practitioners", "value": "56789" } ], "active": true, "period": { "start": "2012-01-01", "end": "2012-03-31" }, "practitioner": { "reference": "Practitioner/0cmRO00000002fgYAA", "display": "Dr Adam Careful" }, "organization": { "reference": "Organization/001RO000004RC9LYAW" }, "code": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0286", "code": "RP" }, { "system": "https://acme.lab/resultcodes", "code": "NEG", "display": "Negative" } ], "text": "Negative for Chlamydia Trachomatis rRNA" }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0286", "code": "RP" }, { "system": "https://acme.lab/resultcodes", "code": "NEG", "display": "Negative" } ] } ], "specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "408478003", "display": "Critical care medicine" } ], "text": "Expert in critical care medicine" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "394812008", "display": "Dental medicine specialties" } ] } ], "location": [ { "reference": "Location/0klRO000000000uYAA", "display": "West Wing, second floor" } ], "availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break." } ``` #### Responses * **201** No match was found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/PractitionerRole/123`. Media type: `application/fhir+json`. Schema: `PractitionerRole (extended)`. Includes all fields of `PractitionerRole`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "resourceType": "PractitionerRole", "identifier": [ { "use": "usual", "system": "http://www.acme.org/practitioners", "value": "12345" }, { "use": "official", "system": "http://www.acme.org/practitioners", "value": "56789" } ], "active": true, "period": { "start": "2012-01-01", "end": "2012-03-31" }, "practitioner": { "reference": "Practitioner/0cmRO00000002fgYAA", "display": "Dr Adam Careful" }, "organization": { "reference": "Organization/001RO000004RC9LYAW" }, "code": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0286", "code": "RP" }, { "system": "https://acme.lab/resultcodes", "code": "NEG", "display": "Negative" } ], "text": "Negative for Chlamydia Trachomatis rRNA" }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0286", "code": "RP" }, { "system": "https://acme.lab/resultcodes", "code": "NEG", "display": "Negative" } ] } ], "specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "408478003", "display": "Critical care medicine" } ], "text": "Expert in critical care medicine" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "394812008", "display": "Dental medicine specialties" } ] } ], "location": [ { "reference": "Location/0klRO000000000uYAA", "display": "West Wing, second floor" } ], "availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break.", "id": "8587" } ``` * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get a practitioner role `GET /PractitionerRole/{id}` Retrieves the details for a particular object using the ID. This operation is performed using the read interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) #### Responses * **200** The request was successful. Media type: `application/fhir+json`. Schema: `PractitionerRole`. _Example_ ``` { "resourceType": "PractitionerRole", "id": "0bSRO00000001h72AA", "identifier": [ { "use": "usual", "system": "http://www.acme.org/practitioners", "value": "12345" }, { "use": "official", "system": "http://www.acme.org/practitioners", "value": "56789" } ], "active": true, "period": { "start": "2012-01-01", "end": "2012-03-31" }, "practitioner": { "reference": "Practitioner/0cmRO00000002fgYAA", "display": "Dr Adam Careful" }, "organization": { "reference": "Organization/001RO000004RC9LYAW" }, "code": [ { "coding": [ { "code": "RP" } ] }, { "coding": [ { "code": "RP" } ] } ], "specialty": [ { "coding": [ { "code": "408478003" } ] }, { "coding": [ { "code": "394812008" } ] } ], "location": [ { "reference": "Location/0klRO000000000uYAA" } ], "availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break." } ``` * **404** Search ID not found. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### PUT Update a practitioner role `PUT /PractitionerRole/{id}` Creates a new current version of an existing resource or creates an initial version if no resource already exists for the given ID. This operation is performed using the update interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `PractitionerRole`. _Example_ ``` { "resourceType": "PractitionerRole", "id": "12385", "identifier": [ { "use": "usual", "system": "http://www.acme.org/practitioners", "value": "12345" }, { "use": "official", "system": "http://www.acme.org/practitioners", "value": "56789" } ], "active": true, "period": { "start": "2012-01-01", "end": "2012-03-31" }, "practitioner": { "reference": "Practitioner/0cmRO00000002fgYAA", "display": "Dr Adam Careful" }, "organization": { "reference": "Organization/001RO000004RC9LYAW" }, "code": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0286", "code": "RP" }, { "system": "https://acme.lab/resultcodes", "code": "NEG", "display": "Negative" } ], "text": "Negative for Chlamydia Trachomatis rRNA" }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0286", "code": "RP" }, { "system": "https://acme.lab/resultcodes", "code": "NEG", "display": "Negative" } ] } ], "specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "408478003", "display": "Critical care medicine" } ], "text": "Expert in critical care medicine" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "394812008", "display": "Dental medicine specialties" } ] } ], "location": [ { "reference": "Location/0klRO000000000uYAA", "display": "West Wing, second floor" } ], "availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break." } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/PractitionerRole/123`. Media type: `application/fhir+json`. Schema: `PractitionerRole`. _Example_ ``` { "resourceType": "PractitionerRole", "id": "213847", "identifier": [ { "use": "usual", "system": "http://www.acme.org/practitioners", "value": "12345" }, { "use": "official", "system": "http://www.acme.org/practitioners", "value": "56789" } ], "active": true, "period": { "start": "2012-01-01", "end": "2012-03-31" }, "practitioner": { "reference": "Practitioner/0cmRO00000002fgYAA", "display": "Dr Adam Careful" }, "organization": { "reference": "Organization/001RO000004RC9LYAW" }, "code": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0286", "code": "RP" }, { "system": "https://acme.lab/resultcodes", "code": "NEG", "display": "Negative" } ], "text": "Negative for Chlamydia Trachomatis rRNA" }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0286", "code": "RP" }, { "system": "https://acme.lab/resultcodes", "code": "NEG", "display": "Negative" } ] } ], "specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "408478003", "display": "Critical care medicine" } ], "text": "Expert in critical care medicine" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "394812008", "display": "Dental medicine specialties" } ] } ], "location": [ { "reference": "Location/0klRO000000000uYAA", "display": "West Wing, second floor" } ], "availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break." } ``` * **201** Created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/PractitionerRole/123`. Media type: `application/fhir+json`. Schema: `PractitionerRole`. _Example: same as PUT /PractitionerRole/{id} 200 response._ * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get encounters `GET /Encounter` Retrieves a set of resources by using filters. #### Parameters * `date` (query, string) Specifies a date within the period when the encounter lasted. * `patient` (query, string, required) Specifies the patient or group present at the encounter. * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Responses * **200** Media type: `application/fhir+json`. Schema: `EncounterBundle (extended)`. Includes all fields of `EncounterBundle`. * `entry` (_array of any_) Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version-specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. Each item: Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be the Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. _Example_ ``` { "resourceType": "Bundle", "id": "e9e75fe7-add6-4312-b6c2-dbf1f076e51e", "meta": { "lastUpdated": "2023-02-13T11:01:00.591+05:30" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "https://localhost:8092/admin/fhir-r4/v1/Encounter?date=2022-01-10T12:00:00.000Z&patient=001RO000004RC9LYAW" } ], "entry": [ { "fullUrl": "https://localhost:8092/Encounter/0kGRO00000001HK2AY", "search": { "mode": "match" }, "resource": { "resourceType": "Encounter", "id": "0kGRO00000001HK2AY", "identifier": [ { "use": "temp", "value": "Encounter_Role_2634641123", "system": "http://healthcare.example.org/identifiers/enocunter" }, { "use": "official", "value": "12345645", "system": "http://healthcare.example.org/identifiers/enocunter" } ], "status": "in-progress", "serviceType": { "coding": [ { "code": "274" } ] }, "class": { "code": "IMP" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "367336008", "display": "Chemotherapy" }, { "system": "http://snomed.info/sct", "code": "367336002", "display": "Sample" } ], "text": "Encounter Type Bundle" } ], "priority": { "coding": [ { "system": "http://snomed.info/sct", "code": "394849002", "display": "High priority" } ], "text": "Encounter Priority Bundle" }, "subject": { "reference": "Patient/001RO000004RC9LYAW" }, "participant": [ { "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2023-01-10T12:30:00.000Z" }, "length": { "value": 140.0, "unit": "wk" }, "hospitalization": { "preAdmissionIdentifier": { "value": "98682", "system": "http://www.bmc.nl/zorgportal/identifiers/pre-admissions" }, "origin": { "reference": "Organization/abc123" }, "admitSource": { "coding": [ { "code": "305997006", "display": "305997006" } ] }, "reAdmission": { "coding": [ { "code": "R", "system": "http://terminology.hl7.org/CodeSystem/v2-0092", "display": "Re-admission" } ], "text": "Encounter Readmission Bundle" }, "dietPreference": [ { "coding": [ { "code": "vegetarian", "display": "Vegetarian" } ] } ], "specialCourtesy": [ { "coding": [ { "code": "ext", "display": "EXT" } ] } ], "destination": { "reference": "Location/abc123" }, "dischargeDisposition": { "coding": [ { "code": "01", "system": "http://www.nubc.org/patient-discharge", "display": "Discharged to Home" } ], "text": "Encounter Readmission Bundle" } }, "location": [ { "location": { "reference": "Location/abc123" }, "status": "planned", "period": { "start": "2022-01-10T11:45:00.000Z", "end": "2022-01-10T13:30:00.000Z" } } ], "serviceProvider": { "reference": "Location/abc123" }, "partOf": { "reference": "Encounter/abc123" } } }, { "fullUrl": "https://localhost:8092/Encounter/ABC123", "search": { "mode": "match" }, "resource": { "resourceType": "Encounter", "id": "0kGRO00000001ID2AY", "identifier": [ { "use": "temp", "value": "Encounter_Role_3", "system": "http://healthcare.example.org/identifiers/enocunter" }, { "use": "official", "value": "1234563784r45", "system": "http://healthcare.example.org/identifiers/enocunter" } ], "status": "in-progress", "serviceType": { "coding": [ { "code": "274" } ] }, "class": { "code": "IMP" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "367336008", "display": "Chemotherapy" }, { "system": "http://snomed.info/sct", "code": "367336002", "display": "Sample" } ], "text": "Encounter Type Bundle" } ], "priority": { "coding": [ { "system": "http://snomed.info/sct", "code": "394849002", "display": "High priority" } ], "text": "Encounter Priority Bundle" }, "subject": { "reference": "Patient/abc123" }, "participant": [ { "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2023-01-10T12:30:00.000Z" }, "length": { "value": 140.0, "unit": "wk" }, "hospitalization": { "preAdmissionIdentifier": { "value": "98682", "system": "http://www.bmc.nl/zorgportal/identifiers/pre-admissions" }, "origin": { "reference": "Organization/abc123" }, "admitSource": { "coding": [ { "code": "305997006", "display": "305997006" } ] }, "dietPreference": [ { "coding": [ { "code": "vegetarian", "display": "Vegetarian" } ] } ], "specialCourtesy": [ { "coding": [ { "code": "ext", "display": "EXT" } ] } ], "destination": { "reference": "Location/abc123" } }, "location": [ { "location": { "reference": "Location/abc123" }, "status": "planned", "period": { "start": "2022-01-10T11:45:00.000Z", "end": "2022-01-10T13:30:00.000Z" } } ], "serviceProvider": { "reference": "Location/abc123" }, "partOf": { "reference": "Encounter/abc123" } } } ] } ``` * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### POST Create an encounter `POST /Encounter` Creates a resource using the create interaction from the FHIR resources. #### Parameters * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Encounter`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example_ ``` { "resourceType": "Encounter", "identifier": [ { "use": "temp", "system": "http://healthcare.example.org/identifiers/enocunter", "value": "Encounter_Role_23343huh42" }, { "use": "official", "system": "http://healthcare.example.org/identifiers/enocunter", "value": "3534945ty5" } ], "status": "in-progress", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "INP", "display": "inpatient encounter" }, "type":[ { "coding": [ { "system": "http://snomed.info/sct", "code": "367336008", "display": "Chemotherapy" }, { "system": "http://snomed.info/sct", "code": "367336002", "display": "Sample" } ] }], "subject": { "reference": "Patient/abc123" }, "period": { "start": "2022-01-10T12:00:00.000Z" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PART" } ] } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } }, { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PARTS" } ] } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } } ], "serviceType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/service-type", "code": "274", "display": "Cancer" } ] }, "priority": { "coding": [ { "system": "http://snomed.info/sct", "code": "394849002", "display": "High priority" } ] } , "basedOn": [{ "reference": "ServiceRequest/abc123" }], "length": { "value": 200, "unit": "min", "system": "http://unitsofmeasure.org", "code": "min" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "34068001", "display": "Chemotherapy" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "340680012", "display": "Chemotherapy2" } ] } ], "reasonReference": [{ "reference": "Observation/abc123" }, { "reference": "Observation/abc123" }], "diagnosis": [{ "condition": { "reference": "Condition/abc123" }, "use": { "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "billing", "display": "Billing" } ] }, "rank": 1 }, { "condition": { "reference": "Condition/abc123" }, "use": { "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "bill", "display": "Bill" } ] }, "rank": 2 } ], "hospitalization": { "preAdmissionIdentifier": { "use": "official", "system": "http://www.bmc.nl/zorgportal/identifiers/pre-admissions", "value": "98682" }, "origin": { "reference": "Organization/abc123" }, "admitSource": { "coding": [ { "system": "http://snomed.info/sct", "code": "305997006", "display": "Referral by radiologist" } ] }, "reAdmission": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0092", "code": "R", "display": "Re-admission" } ] }, "dietPreference": [{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diet", "code": "vegetarian", "display": "Vegetarian" } ] }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diet", "code": "veg", "display": "veg" } ] }], "specialCourtesy": [{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy", "code": "EXT", "display": "extended courtesy" } ] }], "destination": { "reference": "Location/abc123" }, "dischargeDisposition": { "coding": [ { "system": "http://www.nubc.org/patient-discharge", "code": "01", "display": "Discharged to Home" } ] } }, "location": [ { "location": { "reference": "Location/abc123", "display": "Holy Family Hospital" }, "status": "planned", "physicalType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "code": "bu", "display": "Building" } ] }, "period": { "start": "2022-01-10T11:45:00.000Z", "end": "2022-01-10T13:30:00.000Z" } } ], "serviceProvider": { "reference": "Location/abc123" }, "partOf": { "reference": "Encounter/abc123" } } ``` #### Responses * **201** No match was found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Encounter/123`. Media type: `application/fhir+json`. Schema: `Encounter (extended)`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. Includes all fields of `Encounter`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "resourceType": "Encounter", "identifier": [ { "use": "temp", "system": "http://healthcare.example.org/identifiers/enocunter", "value": "Encounter_Role_23343huh42" }, { "use": "official", "system": "http://healthcare.example.org/identifiers/enocunter", "value": "3534945ty5" } ], "status": "in-progress", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "INP", "display": "inpatient encounter" }, "type":[ { "coding": [ { "system": "http://snomed.info/sct", "code": "367336008", "display": "Chemotherapy" }, { "system": "http://snomed.info/sct", "code": "367336002", "display": "Sample" } ] }], "subject": { "reference": "Patient/abc123" }, "period": { "start": "2022-01-10T12:00:00.000Z" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PART" } ] } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } }, { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PARTS" } ] } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } } ], "serviceType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/service-type", "code": "274", "display": "Cancer" } ] }, "priority": { "coding": [ { "system": "http://snomed.info/sct", "code": "394849002", "display": "High priority" } ] } , "basedOn": [{ "reference": "ServiceRequest/abc123" }], "length": { "value": 200, "unit": "min", "system": "http://unitsofmeasure.org", "code": "min" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "34068001", "display": "Chemotherapy" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "340680012", "display": "Chemotherapy2" } ] } ], "reasonReference": [{ "reference": "Observation/abc123" }, { "reference": "Observation/abc123" }], "diagnosis": [{ "condition": { "reference": "Condition/abc123" }, "use": { "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "billing", "display": "Billing" } ] }, "rank": 1 }, { "condition": { "reference": "Condition/abc123" }, "use": { "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "bill", "display": "Bill" } ] }, "rank": 2 } ], "hospitalization": { "preAdmissionIdentifier": { "use": "official", "system": "http://www.bmc.nl/zorgportal/identifiers/pre-admissions", "value": "98682" }, "origin": { "reference": "Organization/abc123" }, "admitSource": { "coding": [ { "system": "http://snomed.info/sct", "code": "305997006", "display": "Referral by radiologist" } ] }, "reAdmission": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0092", "code": "R", "display": "Re-admission" } ] }, "dietPreference": [{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diet", "code": "vegetarian", "display": "Vegetarian" } ] }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diet", "code": "veg", "display": "veg" } ] }], "specialCourtesy": [{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy", "code": "EXT", "display": "extended courtesy" } ] }], "destination": { "reference": "Location/abc123" }, "dischargeDisposition": { "coding": [ { "system": "http://www.nubc.org/patient-discharge", "code": "01", "display": "Discharged to Home" } ] } }, "location": [ { "location": { "reference": "Location/abc123", "display": "Holy Family Hospital" }, "status": "planned", "physicalType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "code": "bu", "display": "Building" } ] }, "period": { "start": "2022-01-10T11:45:00.000Z", "end": "2022-01-10T13:30:00.000Z" } } ], "serviceProvider": { "reference": "Location/abc123" }, "partOf": { "reference": "Encounter/abc123" }, "id": "2345" } ``` * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get an encounter `GET /Encounter/{id}` Retrieves the details for a particular object using the ID. This operation is performed using the read interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) #### Responses * **200** The request was successful. Media type: `application/fhir+json`. Schema: `Encounter`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example_ ``` { "resourceType": "Encounter", "id": "0kGB00000008iYmMAI", "identifier": [ { "use": "temp", "value": "Encounter_311AbcEfgHij", "system": "http://healthcare.example.org/identifiers/enocunter" }, { "use": "official", "value": "Enc_129AbcdPQrStu", "system": "http://healthcare.example.org/identifiers/enocunter" } ], "status": "in-progress", "serviceType": { "coding": [ { "code": "274" } ] }, "class": { "code": "INP" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "3673360083445253211", "display": "Chemo" }, { "system": "http://snomed.info/sct", "code": "3673360028845945934322", "display": "CPA1145" } ], "text": "Encounter Type Bundle" } ], "priority": { "coding": [ { "system": "http://snomed.info/sct", "code": "394849002", "display": "High priority" } ], "text": "Encounter Priority Bundle" }, "subject": { "reference": "Patient/001B000001PjmeSIAR" }, "basedOn": [ { "reference": "ServiceRequest/0jyB0000000CaRCIA0" } ], "participant": [ { "type": [ { "coding": [ { "code": "PART", "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "display": "PART" } ], "text": "Encounter Participant Type Bundle" } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/0cmB0000000H67fIAC" } }, { "type": [ { "coding": [ { "code": "PARTS", "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "display": "PARTS" } ], "text": "Encounter Participant Type Bundle" } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/0cmB0000000H67fIAC" } } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-03-10T17:20:34.000Z" }, "length": { "value": 200.0, "unit": "min" }, "reasonCode": [ { "coding": [ { "code": "34068001", "system": "http://snomed.info/sct", "display": "Chemotherapy" } ], "text": "Encounter Reason Code Bundle0" } ], "reasonReference": [ { "reference": "Condition/0j4B0000000PwPBIA0" } ], "diagnosis": [ { "use": { "coding": [ { "code": "billing", "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "display": "Billing" } ], "text": "Encounter Diagnosis Use Bundle" } , "condition": { "reference": "Condition/0j4B0000000PwPBIA0" }, "rank": 1.0 }, { "use": { "coding": [ { "code": "bill", "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "display": "Bill" } ], "text": "Encounter Diagnosis Use Bundle" } , "condition": { "reference": "Condition/0j4B0000000PwPBIA0" }, "rank": 2.0 } ], "hospitalization": { "origin": { "reference": "Organization/001B000001PjmeSIAR" }, "admitSource": { "coding": [ { "code": "305997006", "display": "305997006" } ] }, "reAdmission": { "coding": [ { "code": "R", "system": "http://terminology.hl7.org/CodeSystem/v2-0092", "display": "Re-admission" } ], "text": "Encounter Readmission Bundle" }, "dietPreference": [ { "coding": [ { "code": "vegetarian", "display": "Vegetarian" } ] }, { "coding": [ { "code": "veg", "display": "veg" } ] } ], "specialCourtesy": [ { "coding": [ { "code": "ext", "display": "EXT" } ] } ], "destination": { "reference": "Location/0klB00000004J5SIAU" }, "dischargeDisposition": { "coding": [ { "code": "01", "system": "http://www.nubc.org/patient-discharge", "display": "Discharged to Home" } ], "text": "Encounter Readmission Bundle" } }, "location": [ { "location": { "reference": "Location/0klB00000004J5SIAU" }, "status": "planned", "period": { "start": "2022-01-10T11:45:00.000Z", "end": "2022-01-10T13:30:00.000Z" }, "physicalType": { "coding": [ { "code": "bu", "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "display": "Building" } ], "text": "Encounter Location Physical Type Bundle" } } ], "serviceProvider": { "reference": "Location/0klB00000004J5SIAU" }, "partOf": { "reference": "Encounter/0kGB0000000PE2jMAG" } } ``` * **404** Search ID not found. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### PUT Update an encounter `PUT /Encounter/{id}` Creates a new current version of an existing resource or creates an initial version if no resource already exists for the given ID. This operation is performed using the update interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Encounter`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example_ ``` { "resourceType": "Encounter", "id": "2345", "identifier": [ { "use": "temp", "system": "http://healthcare.example.org/identifiers/enocunter", "value": "Encounter_Role_23343huh42" }, { "use": "official", "system": "http://healthcare.example.org/identifiers/enocunter", "value": "3534945ty5" } ], "status": "in-progress", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "INP", "display": "inpatient encounter" }, "type":[ { "coding": [ { "system": "http://snomed.info/sct", "code": "367336008", "display": "Chemotherapy" }, { "system": "http://snomed.info/sct", "code": "367336002", "display": "Sample" } ] }], "subject": { "reference": "Patient/abc123" }, "period": { "start": "2022-01-10T12:00:00.000Z" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PART" } ] } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } }, { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PARTS" } ] } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } } ], "serviceType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/service-type", "code": "274", "display": "Cancer" } ] }, "priority": { "coding": [ { "system": "http://snomed.info/sct", "code": "394849002", "display": "High priority" } ] } , "basedOn": [{ "reference": "ServiceRequest/abc123" }], "length": { "value": 200, "unit": "min", "system": "http://unitsofmeasure.org", "code": "min" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "34068001", "display": "Chemotherapy" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "340680012", "display": "Chemotherapy2" } ] } ], "reasonReference": [{ "reference": "Observation/abc123" }, { "reference": "Observation/abc123" }], "diagnosis": [{ "condition": { "reference": "Condition/abc123" }, "use": { "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "billing", "display": "Billing" } ] }, "rank": 1 }, { "condition": { "reference": "Condition/abc123" }, "use": { "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "bill", "display": "Bill" } ] }, "rank": 2 } ], "hospitalization": { "preAdmissionIdentifier": { "use": "official", "system": "http://www.bmc.nl/zorgportal/identifiers/pre-admissions", "value": "98682" }, "origin": { "reference": "Organization/abc123" }, "admitSource": { "coding": [ { "system": "http://snomed.info/sct", "code": "305997006", "display": "Referral by radiologist" } ] }, "reAdmission": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0092", "code": "R", "display": "Re-admission" } ] }, "dietPreference": [{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diet", "code": "vegetarian", "display": "Vegetarian" } ] }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diet", "code": "veg", "display": "veg" } ] }], "specialCourtesy": [{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy", "code": "EXT", "display": "extended courtesy" } ] }], "destination": { "reference": "Location/abc123" }, "dischargeDisposition": { "coding": [ { "system": "http://www.nubc.org/patient-discharge", "code": "01", "display": "Discharged to Home" } ] } }, "location": [ { "location": { "reference": "Location/abc123", "display": "Holy Family Hospital" }, "status": "planned", "physicalType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "code": "bu", "display": "Building" } ] }, "period": { "start": "2022-01-10T11:45:00.000Z", "end": "2022-01-10T13:30:00.000Z" } } ], "serviceProvider": { "reference": "Location/abc123" }, "partOf": { "reference": "Encounter/abc123" } } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Encounter/123`. Media type: `application/fhir+json`. Schema: `Encounter`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example_ ``` { "resourceType": "Encounter", "id": "2345", "identifier": [ { "use": "temp", "system": "http://healthcare.example.org/identifiers/enocunter", "value": "Encounter_Role_23343huh42" }, { "use": "official", "system": "http://healthcare.example.org/identifiers/enocunter", "value": "3534945ty5" } ], "status": "in-progress", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "INP", "display": "inpatient encounter" }, "type":[ { "coding": [ { "system": "http://snomed.info/sct", "code": "367336008", "display": "Chemotherapy" }, { "system": "http://snomed.info/sct", "code": "367336002", "display": "Sample" } ] }], "subject": { "reference": "Patient/abc123" }, "period": { "start": "2022-01-10T12:00:00.000Z" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PART" } ] } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } }, { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PARTS" } ] } ], "period": { "start": "2022-01-10T12:00:00.000Z", "end": "2022-01-10T12:30:00.000Z" }, "individual": { "reference": "Practitioner/abc123" } } ], "serviceType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/service-type", "code": "274", "display": "Cancer" } ] }, "priority": { "coding": [ { "system": "http://snomed.info/sct", "code": "394849002", "display": "High priority" } ] } , "basedOn": [{ "reference": "ServiceRequest/abc123" }], "length": { "value": 200, "unit": "min", "system": "http://unitsofmeasure.org", "code": "min" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "34068001", "display": "Chemotherapy" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "340680012", "display": "Chemotherapy2" } ] } ], "reasonReference": [{ "reference": "Observation/abc123" }, { "reference": "Observation/abc123" }], "diagnosis": [{ "condition": { "reference": "Condition/abc123" }, "use": { "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "billing", "display": "Billing" } ] }, "rank": 1 }, { "condition": { "reference": "Condition/abc123" }, "use": { "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "bill", "display": "Bill" } ] }, "rank": 2 } ], "hospitalization": { "preAdmissionIdentifier": { "use": "official", "system": "http://www.bmc.nl/zorgportal/identifiers/pre-admissions", "value": "98682" }, "origin": { "reference": "Organization/abc123" }, "admitSource": { "coding": [ { "system": "http://snomed.info/sct", "code": "305997006", "display": "Referral by radiologist" } ] }, "reAdmission": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0092", "code": "R", "display": "Re-admission" } ] }, "dietPreference": [{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diet", "code": "vegetarian", "display": "Vegetarian" } ] }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diet", "code": "veg", "display": "veg" } ] }], "specialCourtesy": [{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy", "code": "EXT", "display": "extended courtesy" } ] }], "destination": { "reference": "Location/abc123" }, "dischargeDisposition": { "coding": [ { "system": "http://www.nubc.org/patient-discharge", "code": "01", "display": "Discharged to Home" } ] } }, "location": [ { "location": { "reference": "Location/abc123", "display": "Holy Family Hospital" }, "status": "planned", "physicalType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "code": "bu", "display": "Building" } ] }, "period": { "start": "2022-01-10T11:45:00.000Z", "end": "2022-01-10T13:30:00.000Z" } } ], "serviceProvider": { "reference": "Location/abc123" }, "partOf": { "reference": "Encounter/abc123" } } ``` * **201** Created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Encounter/123`. Media type: `application/fhir+json`. Schema: `Encounter`. Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. _Example: same as PUT /Encounter/{id} 200 response._ * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### POST Create a location record `POST /Location` Creates a resource using the create interaction from the FHIR resources. #### Parameters * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Location`. _Example_ ``` { "resourceType": "Location", "identifier": [{ "use": "usual", "system": "http://www.acme.org/location", "value": "B1-S.F2" }, { "use": "usual", "system": "http://www.acme.org/location", "value": "B2-S.F2" }], "status": "active", "name": "South Wing, Fifth floor", "description": "Fifth floor of the Old South Wing, formerly in use by Psychiatry", "type": [{ "coding": [{ "system": "http://snomed.info/sct", "code": "DX", "display": "Diagnostics or therapeutics unit" }], "text": "Diagnostics or therapeutics unit" } ], "telecom": [{ "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "123456789", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } } ], "address": { "use": "home", "text": "Karen Smith", "line": ["1003 Healthcare Home" , "103 Healthcare Home"], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "physicalType": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "code": "wi", "display": "Wing" }] }, "position": { "longitude": -83.6945691, "latitude": 42.25475478 }, "partOf": { "reference": "Location/0klB00000004HEmIAM" }, "hoursOfOperation": [{ "daysOfWeek": ["mon", "tue", "wed"], "openingTime": "05:48:19", "closingTime": "12:48:19" }, { "daysOfWeek": ["thu", "fri","sat"], "openingTime": "05:48:21", "closingTime": "12:48:21" } ], "availabilityExceptions": "when unavailable ", "managingOrganization": { "reference": "Organization/001B000001Pjme6IAB" } } ``` #### Responses * **201** No match was found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Location/123`. Media type: `application/fhir+json`. Schema: `Location (extended)`. Includes all fields of `Location`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "resourceType": "Location", "identifier": [{ "use": "usual", "system": "http://www.acme.org/location", "value": "B1-S.F2" }, { "use": "usual", "system": "http://www.acme.org/location", "value": "B2-S.F2" }], "status": "active", "name": "South Wing, Fifth floor", "description": "Fifth floor of the Old South Wing, formerly in use by Psychiatry", "type": [{ "coding": [{ "system": "http://snomed.info/sct", "code": "DX", "display": "Diagnostics or therapeutics unit" }], "text": "Diagnostics or therapeutics unit" } ], "telecom": [{ "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "123456789", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } } ], "address": { "use": "home", "text": "Karen Smith", "line": ["1003 Healthcare Home" , "103 Healthcare Home"], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "physicalType": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "code": "wi", "display": "Wing" }] }, "position": { "longitude": -83.6945691, "latitude": 42.25475478 }, "partOf": { "reference": "Location/0klB00000004HEmIAM" }, "hoursOfOperation": [{ "daysOfWeek": ["mon", "tue", "wed"], "openingTime": "05:48:19", "closingTime": "12:48:19" }, { "daysOfWeek": ["thu", "fri","sat"], "openingTime": "05:48:21", "closingTime": "12:48:21" } ], "availabilityExceptions": "when unavailable ", "managingOrganization": { "reference": "Organization/001B000001Pjme6IAB" }, "id": "36425" } ``` * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get a location record `GET /Location/{id}` Retrieves the details for a particular object using the ID. This operation is performed using the read interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) #### Responses * **200** The request was successful. Media type: `application/fhir+json`. Schema: `Location`. _Example_ ``` { "resourceType": "Location", "id": "0klB00000004J8WIAU", "identifier": [ { "use": "usual", "system": "http://www.acme.org/location", "value": "B1-S.F2" }, { "use": "usual", "system": "http://www.acme.org/location", "value": "B2-S.F2" } ], "status": "active", "name": "South Wing, Fifth floor", "description": "Fifth floor of the Old South Wing, formerly in use by Psychiatry", "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "DX", "display": "Diagnostics or therapeutics unit" } ], "text": "Diagnostics or therapeutics unit" } ], "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "123456789", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } } ], "address": { "use": "home", "line": [ "1003 Healthcare Home", "103 Healthcare Home" ], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND" }, "physicalType": { "coding": [ { "code": "wi" } ] }, "position": { "longitude": -83.6945691, "latitude": 42.25475478 }, "partOf": { "reference": "Location/0klB00000004HEmIAM" }, "hoursOfOperation": [ { "daysOfWeek": [ "mon", "tue", "wed", "sun" ], "openingTime": "05:48:19.000", "closingTime": "12:48:19.000" }, { "daysOfWeek": [ "thu", "fri", "sat" ], "openingTime": "05:48:21.000", "closingTime": "12:48:21.000" } ], "availabilityExceptions": "when unavailable", "managingOrganization": { "reference": "Organization/001B000001Pjme6IAB" } } ``` * **404** Search ID not found. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### PUT Update a location record `PUT /Location/{id}` Creates a new current version of an existing resource or creates an initial version if no resource already exists for the given ID. This operation is performed using the update interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Location`. _Example_ ``` { "resourceType": "Location", "id": "36425", "identifier": [{ "use": "usual", "system": "http://www.acme.org/location", "value": "B1-S.F2" }, { "use": "usual", "system": "http://www.acme.org/location", "value": "B2-S.F2" }], "status": "active", "name": "South Wing, Fifth floor", "description": "Fifth floor of the Old South Wing, formerly in use by Psychiatry", "type": [{ "coding": [{ "system": "http://snomed.info/sct", "code": "DX", "display": "Diagnostics or therapeutics unit" }], "text": "Diagnostics or therapeutics unit" } ], "telecom": [{ "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "123456789", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } } ], "address": { "use": "home", "text": "Karen Smith", "line": ["1003 Healthcare Home" , "103 Healthcare Home"], "city": "Delhi", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "physicalType": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "code": "wi", "display": "Wing" }] }, "position": { "longitude": -83.6945691, "latitude": 42.25475478 }, "partOf": { "reference": "Location/0klB00000004HEmIAM" }, "hoursOfOperation": [{ "daysOfWeek": ["mon", "tue", "wed"], "openingTime": "05:48:19", "closingTime": "12:48:19" }, { "daysOfWeek": ["thu", "fri","sat"], "openingTime": "05:48:21", "closingTime": "12:48:21" } ], "availabilityExceptions": "when unavailable ", "managingOrganization": { "reference": "Organization/001B000001Pjme6IAB" } } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Location/123`. Media type: `application/fhir+json`. Schema: `Location`. _Example: same as POST /Location 201 response._ * **201** Created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Location/123`. Media type: `application/fhir+json`. Schema: `Location`. _Example: same as POST /Location 201 response._ * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get organization records `GET /Organization` Retrieves a set of resources by using filters. #### Parameters * `identifier` (query, string | integer) Specifies an organization's identifier. Search is performed on - a)identifier 'code' b)identifier with 'system' and 'code'. * `name` (query, string) Specifies a portion of the organization's name or alias. * `address` (query, string) Specifies a server-defined search that matches any of the string fields in the address use, city, state, country, or postalCode. * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Responses * **200** Media type: `application/fhir+json`. Schema: `OrganizationBundle (extended)`. Includes all fields of `OrganizationBundle`. * `entry` (_array of any_) Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version-specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. Each item: Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be the Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. _Example_ ``` { "resourceType": "Bundle", "id": "53234232-82c6-42d4-9e4c-e57422e9337e", "meta": { "lastUpdated": "2023-03-24T14:09:41.291+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://localhost:8092/admin/fhir-r4/v1/Organization?identifier=ident987654" } ], "entry": [ { "fullUrl": "https://localhost:8092/admin/fhir-r4/v1/Organization/001RO000004bnsHYAQ", "search": { "mode": "match" }, "resource": { "resourceType": "Organization", "id": "001RO000004bnsHYAQ", "identifier": [ { "value": "ident987654", "use": "official", "system": "System" } ], "active": true, "type": [ { "coding": [ { "code": "V6" } ] } ], "name": "Jason Dune", "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [ { "use": "home", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "contact": [ { "purpose": { "coding": [ { "code": "BILL" } ] }, "name": { "family": "Test7", "given": [ "Phoebe" ], "suffix": [ "suffix" ], "prefix": [ "Dr" ], "use": "usual" }, "telecom": [ { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "home", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } }, { "purpose": { "coding": [ { "code": "HR" } ] }, "name": { "family": "Checkkk", "given": [ "Jane" ], "suffix": [ "suffix" ], "prefix": [ "Dr" ], "use": "usual" }, "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "email", "value": "test@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "work", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } } ] } } ] } ``` * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### POST Create an organization record `POST /Organization` Creates a resource using the create interaction from the FHIR resources. #### Parameters * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Organization`. _Example_ ``` { "resourceType": "Organization", "identifier": [ { "value": "ident9888888888", "use": "official", "system": "System" } ], "active": true, "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/organization-type", "code": "prov", "display": "Healthcare Provider" } ], "text":"An organization that provides healthcare services." } ], "name": "Jason Dune", "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [ { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "contact": [ { "purpose": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/contactentity-type", "code": "BILL", "display": "Billing" } ], "text": "Contact details for information regarding to billing/general finance enquiries." }, "name": { "use": "official", "family": "silva", "given": ["Peter"], "text": "Peter silva", "prefix": ["Dr"], "suffix": ["Jr"], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, "address": { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ] } ] } ``` #### Responses * **201** No match was found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Organization/123`. Media type: `application/fhir+json`. Schema: `Organization (extended)`. Includes all fields of `Organization`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "resourceType": "Organization", "identifier": [ { "value": "ident9888888888", "use": "official", "system": "System" } ], "active": true, "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/organization-type", "code": "prov", "display": "Healthcare Provider" } ], "text": "An organization that provides healthcare services." } ], "name": "Jason Dune", "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [ { "use": "home", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "contact": [ { "purpose": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/contactentity-type", "code": "BILL", "display": "Billing" } ], "text": "Contact details for information regarding to billing/general finance enquiries." }, "name": { "use": "official", "family": "silva", "given": [ "Peter" ], "text": "Peter silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, "address": { "use": "home", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ] } ], "id": "001B000001U6KdXIAV" } ``` * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get an organization record `GET /Organization/{id}` Retrieves the details for a particular object using the ID. This operation is performed using the read interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) #### Responses * **200** The request was successful. Media type: `application/fhir+json`. Schema: `Organization`. _Example_ ``` { "resourceType": "Organization", "id": "001RO000004bnsHYAQ", "identifier": [ { "value": "ident987654", "use": "official", "system": "System" } ], "active": true, "type": [ { "coding": [ { "code": "V6" } ] } ], "name": "Jason Dune", "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [ { "use": "home", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "contact": [ { "purpose": { "coding": [ { "code": "BILL" } ] }, "name": { "family": "Test7", "given": [ "Phoebe" ], "suffix": [ "suffix" ], "prefix": [ "Dr" ], "use": "usual" }, "telecom": [ { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "home", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } }, { "purpose": { "coding": [ { "code": "HR" } ] }, "name": { "family": "Checkkk", "given": [ "Jane" ], "suffix": [ "suffix" ], "prefix": [ "Dr" ], "use": "usual" }, "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "email", "value": "test@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "work", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } } ] } ``` * **404** Search ID not found. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### PUT Update an organization record `PUT /Organization/{id}` Creates a new current version of an existing resource or creates an initial version if no resource already exists for the given ID. This operation is performed using the update interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `Organization`. _Example_ ``` { "resourceType": "Organization", "identifier": [ { "value": "abc123", "use": "official", "system": "System" } ], "active": true, "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/organization-type", "code": "prov", "display": "Healthcare Provider" } ], "text": "An organization that provides healthcare services." } ], "name": "Jason Dune", "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": [ { "use": "home", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "contact": [ { "purpose": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/contactentity-type", "code": "BILL", "display": "Billing" } ], "text": "Contact details for information regarding to billing/general finance enquiries." }, "name": { "use": "official", "family": "silva", "given": [ "Peter" ], "text": "Peter silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, "address": { "use": "home", "line": [ "1003 Healthcare Home" ], "city": "Abc", "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "telecom": [ { "system": "phone", "value": "999413455190", "use": "work", "rank": 1, "period": { "start": "2022-01-10", "end": "2022-10-10" } }, { "system": "phone", "value": "990000233414", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "email", "value": "abrd@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ] } ], "id": "001B000001U6KpSIAV" } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Organization/123`. Media type: `application/fhir+json`. Schema: `Organization`. _Example: same as PUT /Organization/{id} request._ * **201** Created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Organization/123`. Media type: `application/fhir+json`. Schema: `Organization`. _Example: same as PUT /Organization/{id} request._ * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get related person records `GET /RelatedPerson` Retrieves a set of resources by using filters. #### Parameters * `patient` (query, string, required) Specifies the patient the person is related to. * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Responses * **200** Media type: `application/fhir+json`. Schema: `RelatedPersonBundle (extended)`. Includes all fields of `RelatedPersonBundle`. * `entry` (_array of any_) Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version-specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. Each item: Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be the Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. _Example_ ``` { "resourceType": "Bundle", "id": "15086923-a101-4f6f-a908-b2ad36b0221e", "meta": { "lastUpdated": "2023-06-01T12:19:43.004778+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://localhost:8092/admin/fhir-r4/v1/RelatedPerson?patient=001RO000004lrTr" } ], "entry": [ { "fullUrl": "https://localhost:8092/admin/fhir-r4/v1/RelatedPerson/001RO000004m56cYAA", "search": { "mode": "match" }, "resource": { "resourceType": "RelatedPerson", "id": "001RO000004m56cYAA", "active": true, "patient": { "reference": "Patient/001RO000004lrTrYAI" }, "relationship": [ { "coding": [ { "code": "Wife", "display": "Spouse" } ] } ], "name": [ { "family": "Abels", "text": "Sarah Abels", "given": [ "Sarah" ], "suffix": [ "Jr" ], "prefix": [ "Ms" ], "use": "usual", "period": { "start": "2012-03-11", "end": "2023-03-11" } } ], "telecom": [ { "system": "phone", "value": "+33 (237) 998327", "use": "work", "rank": 1, "period": { "start": "2012-03-11", "end": "2023-03-11" } }, { "system": "email", "value": "s.abels@kpn.nl", "use": "home", "rank": 1, "period": { "start": "2012-03-11" } } ], "gender": "female", "birthDate": "1973-05-31", "address": [ { "use": "home", "line": [ "43, Place du Marché Sainte Catherine" ], "city": "Paris", "state": "London", "postalCode": "75004", "country": "FRA", "period": { "start": "2012-03-11", "end": "2023-03-11" } } ], "period": { "start": "2012-03-11", "end": "2023-03-11" }, "communication": [ { "language": { "coding": [ { "code": "English" } ] }, "preferred": true } ] } } ] } ``` * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### POST Create a related person record `POST /RelatedPerson` Creates a resource using the create interaction from the FHIR resources. #### Parameters * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `RelatedPerson`. _Example_ ``` { "recordTypeLabel": "RelatedPerson", "resourceType": "RelatedPerson", "active": true, "patient": { "reference": "Patient/001RO0000045Ni3YAE" }, "relationship": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "WIFE", "display": "Not known" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE", "display": "Spouse" } ], "text": "Negative for Chlamydia Trachomatis rRNA" }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "Partner2", "display": "Not known" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE", "display": "Spouse" } ], "text": "Negative for Chlamydia Trachomatis rRNA1" } ], "name": [ { "use": "usual", "text":"Sarah Abels", "family": "Abels", "given": [ "Sarah", "Link" ], "prefix": ["Ms"], "suffix": ["Jr"], "period": { "start": "2012-03-11", "end": "2023-03-11" } } ], "telecom": [ { "system": "phone", "value": "+33 (237) 998327", "use": "work", "rank": 1, "period": { "start": "2012-03-11", "end": "2023-03-11" } }, { "system": "email", "value": "s.abels@kpn.nl", "use": "home", "rank": 1, "period": { "start": "2012-03-11" } } ], "gender": "female", "birthDate": "1973-05-31", "address": [ { "use": "home", "line": [ "43, Place du Marché Sainte Catherine" ], "city": "Paris", "state": "London", "postalCode": "75004", "country": "FRA", "period": { "start": "2012-03-11", "end": "2023-03-11" } } ], "period": { "start": "2012-03-11", "end": "2023-03-11" }, "communication":[ {"language": {"coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "ENG", "display": "English" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0132", "code": "FRA", "display": "French" } ], "text": "bdhgfjh" } , "preferred": true } ] } ``` #### Responses * **201** No match was found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/RelatedPerson/123`. Media type: `application/fhir+json`. Schema: `RelatedPerson (extended)`. Includes all fields of `RelatedPerson`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "recordTypeLabel": "RelatedPerson", "resourceType": "RelatedPerson", "active": true, "patient": { "reference": "Patient/001RO0000045Ni3YAE" }, "relationship": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "WIFE", "display": "Not known" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE", "display": "Spouse" } ], "text": "Negative for Chlamydia Trachomatis rRNA" }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "Partner2", "display": "Not known" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE", "display": "Spouse" } ], "text": "Negative for Chlamydia Trachomatis rRNA1" } ], "name": [ { "use": "usual", "text":"Sarah Abels", "family": "Abels", "given": [ "Sarah", "Link" ], "prefix": ["Ms"], "suffix": ["Jr"], "period": { "start": "2012-03-11", "end": "2023-03-11" } } ], "telecom": [ { "system": "phone", "value": "+33 (237) 998327", "use": "work", "rank": 1, "period": { "start": "2012-03-11", "end": "2023-03-11" } }, { "system": "email", "value": "s.abels@kpn.nl", "use": "home", "rank": 1, "period": { "start": "2012-03-11" } } ], "gender": "female", "birthDate": "1973-05-31", "address": [ { "use": "home", "line": [ "43, Place du Marché Sainte Catherine" ], "city": "Paris", "state": "London", "postalCode": "75004", "country": "FRA", "period": { "start": "2012-03-11", "end": "2023-03-11" } } ], "period": { "start": "2012-03-11", "end": "2023-03-11" }, "communication":[ {"language": {"coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "ENG", "display": "English" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0132", "code": "FRA", "display": "French" } ], "text": "bdhgfjh" } , "preferred": true } ], "id": "123456789" } ``` * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### GET Get a related person record `GET /RelatedPerson/{id}` Retrieves the details for a particular object using the ID. This operation is performed using the read interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) #### Responses * **200** The request was successful. Media type: `application/fhir+json`. Schema: `RelatedPerson`. _Example_ ``` { "resourceType": "RelatedPerson", "id": "001RO000004mF0aYAE", "active": true, "patient": { "reference": "Patient/001RO0000045Ni3YAE" }, "relationship": [ { "coding": [ { "code": "Wife", "display": "Spouse" } ] } ], "name": [ { "family": "Abels", "text": "Sarah Abels", "given": [ "Sarah" ], "suffix": [ "Jr" ], "prefix": [ "Ms" ], "use": "usual", "period": { "start": "2012-03-11", "end": "2023-03-11" } } ], "telecom": [ { "system": "phone", "value": "+33 (237) 998327", "use": "work", "rank": 1, "period": { "start": "2012-03-11", "end": "2023-03-11" } }, { "system": "email", "value": "s.abels@kpn.nl", "use": "home", "rank": 1, "period": { "start": "2012-03-11" } } ], "gender": "female", "birthDate": "1973-05-31", "address": [ { "use": "home", "line": [ "43, Place du Marché Sainte Catherine" ], "city": "Paris", "state": "London", "postalCode": "75004", "country": "FRA", "period": { "start": "2012-03-11", "end": "2023-03-11" } } ], "period": { "start": "2012-03-11", "end": "2023-03-11" }, "communication": [ { "language": { "coding": [ { "code": "English" } ] }, "preferred": true } ] } ``` * **404** Search ID not found. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ### PUT Update a related person record `PUT /RelatedPerson/{id}` Creates a new current version of an existing resource or creates an initial version if no resource already exists for the given ID. This operation is performed using the update interaction from the FHIR resources. #### Parameters * `id` (path, id, required) * `Accept` (header, string) Allowed values: `application/fhir+json`. * `X-CORRELATION-ID` (header, string) #### Request body Media type: `application/fhir+json`. Schema: `RelatedPerson`. _Example_ ``` { "recordTypeLabel": "RelatedPerson", "resourceType": "RelatedPerson", "id": "001RO000004kwNUYAY", "active": true, "patient": { "reference": "Patient/001RO0000045Ni3YAE" }, "relationship": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "N", "display": "Not known" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE", "display": "Spouse" } ], "text": "Negative for Chlamydia Trachomatis rRNA" }, { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "N1", "display": "Not known" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE1", "display": "Spouse" } ], "text": "Negative for Chlamydia Trachomatis rRNA1" } ], "name": [ { "use": "usual", "text":"Sarah Abels", "family": "Abels", "given": [ "Sarah", "Link" ], "prefix": ["Ms"], "suffix": ["Jr"], "period": { "start": "2023-03-11", "end": "2023-03-11" } } ], "telecom": [ { "system": "phone", "value": "+33 (237) 998327", "use": "work", "rank": 1, "period": { "start": "2012-03-11", "end": "2023-03-11" } }, { "system": "email", "value": "s.abels@kpn.nl", "use": "home", "rank": 1, "period": { "start": "2012-03-11" } } ], "gender": "female", "birthDate": "1973-05-31", "address": [ { "use": "home", "line": [ "43, Place du Marché Sainte Catherine" ], "city": "Paris", "state": "London", "postalCode": "75004", "country": "FRA", "period": { "start": "2012-03-11", "end": "2023-03-11" } } ], "period": { "start": "2023-03-11", "end": "2023-03-11" }, "communication":[ {"language": {"coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "ENG", "display": "English" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0132", "code": "FRA", "display": "French" } ], "text": "bdhgfjh" } , "preferred": true } ] } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/RelatedPerson/123`. Media type: `application/fhir+json`. Schema: `RelatedPerson`. _Example: same as PUT /RelatedPerson/{id} request._ * **201** Created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/RelatedPerson/123`. Media type: `application/fhir+json`. Schema: `RelatedPerson`. _Example: same as PUT /RelatedPerson/{id} request._ * **400** Resource either can’t be parsed or failed basic FHIR validation rules. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **500** Something went wrong. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Patient 500 response._ ## Schemas ### PatientBundle Includes all fields of `Bundle`. * `entry` (_array of PatientEntry_) ### OperationOutcome Information about the success or failure of an action. Elements defined in Ancestors id, meta, implicitRules, language, text, contained, extension, modifierExtension. Includes all fields of `Resource`. * `issue` (_array of object_, required) * `severity` (_code (string)_, required) fatal | error | warning | information Allowed values: `fatal`, `error`, `warning`, `information`. * `code` (_code (string)_, required) Error or warning code Allowed values: `invalid`, `structure`, `required`, `value`, `invariant`, `security`, `login`, `unknown`, `expired`, `forbidden`, `suppressed`, `processing`, `not-supported`, `duplicate`, `multiple-matches`, `not-found`, `deleted`, `too-long`, `code-invalid`, `extension`, `too-costly`, `business-rule`, `conflict`, `transient`, `lock-error`, `no-store`, `exception`, `timeout`, `incomplete`, `throttled`, `informational`. * `details` (_object_) Additional details about the error Includes all fields of `CodeableConcept`. ### Patient Includes all fields of `DomainResource`. * `identifier` (_array of Identifier_, required) Specifies an identifier for the patient. The 'system' and 'value' identifier properties are mandatory for the identifier property of the Patient resource. * `active` (_boolean_) Specifies whether the patient's record is in active use (true) or not (false). * `name` (_array of HumanName_, required) Specifies a name associated with the patient. * `telecom` (_array of ContactPoint_) Specifies contact details of the individual. The 'system' and 'value' ContactPoint properties are mandatory for the telecom property of the Patient resource. * `gender` (_code (string)_, required) Specifies the gender of the patient. Possible values are male, female, other, and unknown. Allowed values: `male`, `female`, `other`, `unknown`. * `birthDate` (_date (string)_) Specifies the date of birth of the patient. * `deceased` (_object_) Specifies if the patient is deceased. Includes all fields of `patientdeceasedDateTime`. * `multipleBirth` (_object_) Specifies whether the patient is a part of multiple births. Includes all fields of `patientmultipleBirthInteger`. * `address` (_array of Address_) Specifies the address of the individual. * `maritalStatus` (_object_) Specifies the marital (civil) status of the patient. Includes all fields of `CodeableConcept`. * `recordTypeLabel` (_string_) Specifies the record type in Salesforce. * `contact` (_array of object_) Specifies a contact party, such as a guardian, partner, friend. The patient must at least contain the contact's details or a reference to an organization. Includes all fields of `BackboneElement`. * `relationship` (_array of CodeableConcept_) Specifies the kind of relationship. * `name` (_object_) Specifies the name associated with the contact person. Includes all fields of `HumanName`. * `telecom` (_array of ContactPoint_) Specifies the contact details of the contact person. * `address` (_object_) Specifies the address of the contact person. Includes all fields of `Address`. * `gender` (_code (string)_) Specifies the gender. Possible values are male, female, other, and unknown. Allowed values: `male`, `female`, `other`, `unknown`. * `period` (_object_) Specifies the period during which the contact person or organization can be contacted for information related to the patient. Includes all fields of `Period`. * `managingOrganization` (_object_) Specifies the organization that's the custodian of the patient record. Includes all fields of `Reference`. ### id Specifies any combination of upper or lower case ASCII letters ('A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-', and '.', with a length limit of 64 characters. The ID can be an integer, an un-prefixed OID, UUID, or any other identifier pattern that meets the specified constraints. Type: `string`. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. ### PractitionerBundle Includes all fields of `Bundle`. * `entry` (_array of PractitionerEntry_) ### Practitioner Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities. The Practitioner resource is used for attribution of the activities and responsibilities to these individuals. Includes all fields of `DomainResource`. * `identifier` (_array of Identifier_, required) Specifies an identifier for the person as the agent. The 'system' and 'value' identifier properties are mandatory for identifier property of the Practitioner resource. For 'Identifier:NPI' property, only 'system' property is mandatory. * `active` (_boolean_) Indicates whether the practitioner's record is in active use (true) or not (false). * `name` (_array of HumanName_, required) Specifies one or more names associated with the practitioner. The 'family' property of HumanName element type is mandatory for name property. * `telecom` (_array of ContactPoint_) Specifies the contact details of the practitioner that apply to all roles. * `address` (_array of Address_) Specifies one or more addresses of the practitioner that aren't role-specific, which is typically a home address. * `gender` (_code (string)_) Specifies the gender of the practitioner. Allowed values: `male`, `female`, `other`, `unknown`. * `birthDate` (_date (string)_) Specifies the date of birth of the practitioner. * `qualification` (_array of object_) Specifies the credentials of the practitioner, such as certification, licenses, and training pertaining to the provision of care. Includes all fields of `BackboneElement`. * `identifier` (_array of Identifier_) Specifies the identifier for the qualification of the practitioner. * `code` (_object_, required) Specifies the coded representation of the qualification. Includes all fields of `CodeableConcept`. * `period` (_object_) Specifies the period of validity of the qualification. Includes all fields of `Period`. * `issuer` (_object_) Specifies the name of the board certification issuer. Includes all fields of `Reference`. * `recordTypeLabel` (_string_) Specifies the record type in Salesforce. ### PractitionerRoleBundle Includes all fields of `Bundle`. * `entry` (_array of PractitionerRoleEntry_) ### PractitionerRole Specifies the roles or organizations the practitioner is associated with. Elements defined in ancestors: id, meta, implicitRules, language, text, contained, extension, and modifierExtension. Includes all fields of `DomainResource`. * `identifier` (_array of Identifier_) Specifies the business identifiers that are specific to a role or location. * `active` (_boolean_) Indicates whether the practitioner role record is in active use (true) or not (false). * `period` (_object_) Specifies the period during which the practitioner is authorized to perform in the roles. Includes all fields of `Period`. * `practitioner` (_object_, required) Specifies the practitioner that's able to provide the defined services for the organization. Includes all fields of `Reference`. * `organization` (_object_) Specifies the organization where the roles are available. Includes all fields of `Reference`. * `code` (_array of CodeableConcept_) Specifies the roles which the practitioner can perform. * `speciality` (_array of CodeableConcept_) Specifies the specialty of the practitioner. * `location` (_array of Reference_) Specifies one or more locations at which the practitioner provides care. * `availabilityExceptions` (_string_) Provides description of the availability exceptions. ### EncounterBundle Includes all fields of `Bundle`. * `entry` (_array of EncounterEntry_) ### Encounter Includes all fields of `DomainResource`. * `identifier` (_array of Identifier_) Specifies one or more identifiers by which the encounter is known. The 'system' and 'value' identifier properties are mandatory for the identifier property of the encounter resource. * `status` (_code (string)_, required) Specifies the encounter status. Possible values are planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, and unknown. Allowed values: `planned`, `arrived`, `triaged`, `in-progress`, `onleave`, `finished`, `cancelled`, `entered-in-error`, `unknown`. * `class` (_object_, required) Specifies the encounter class. Includes all fields of `Coding`. * `type` (_array of CodeableConcept_, required) Specifies the type of encounter. * `serviceType` (_object_) Specifies the type of service. Includes all fields of `CodeableConcept`. * `priority` (_object_) Specifies the urgency of the encounter. Includes all fields of `CodeableConcept`. * `subject` (_object_, required) Specifies the patient or group present at the encounter. Includes all fields of `Reference`. * `basedOn` (_array of Reference_) Specifies the service request that initiated the encounter. * `participant` (_array of object_) Specifies the list of participants involved in the encounter. Includes all fields of `BackboneElement`. * `type` (_array of CodeableConcept_) Specifies the role of the participant in the encounter. * `period` (_object_) Specifies the period during the encounter for the participation. Includes all fields of `Period`. * `individual` (_object_, required) Specifies the people involved in the encounter other than the patient. 'individual' is mandatory field when passed 'participant' Includes all fields of `Reference`. * `period` (_object_, required) Specifies the start and end time of the encounter. Includes all fields of `Period`. * `length` (_any_) Specifies the quantity of time the encounter lasted. * `reasonCode` (_array of CodeableConcept_) Specifies the reason for the encounter (code). * `reasonReference` (_array of Reference_) Specifies the reason for the encounter (reference). * `diagnosis` (_array of object_) Specifies the list of diagnoses relevant to the encounter. Includes all fields of `BackboneElement`. * `condition` (_object_, required) Specifies the reason for the encounter (resource). Includes all fields of `Reference`. * `use` (_object_) Specifies the role that the diagnosis has within the encounter, such as admission, billing, discharge. Includes all fields of `CodeableConcept`. * `rank` (_positiveInt (integer)_) Specifies the ranking of the diagnosis for each role type. * `hospitalization` (_object_) Provides details about the admission to a healthcare service. Includes all fields of `BackboneElement`. * `preAdmissionIdentifier` (_object_) Specifies the pre-admission identifier. Includes all fields of `Identifier`. * `origin` (_object_) Specifies the location of the patient. Includes all fields of `Reference`. * `admitSource` (_object_) Specifies the source from where the patient was admitted, such as physician referral or transfer. Includes all fields of `CodeableConcept`. * `reAdmission` (_object_) Specifies the type of hospital readmission that has occurred, if any. If the value is absent, then this case isn't identified as a readmission. Includes all fields of `CodeableConcept`. * `dietPreference` (_array of CodeableConcept_) Specifies the diet preferences reported by the patient. * `specialCourtesy` (_array of CodeableConcept_) Specifies the special courtesies, such as VIP, board member. * `destination` (_object_) Specifies the location to which the patient is discharged. Includes all fields of `Reference`. * `dischargeDisposition` (_object_) Specifies the category or kind of location after discharge. Includes all fields of `CodeableConcept`. * `location` (_array of object_) Specifies the list of locations where the patient has been. Includes all fields of `BackboneElement`. * `location` (_object_, required) Specifies the location where the encounter took place. Includes all fields of `Reference`. * `status` (_code (string)_) Specifies the encounter location status. Allowed values: `planned`, `active`, `reserved`, `completed`. * `physicalType` (_object_) Specifies the physical type of the location, which is usually the level in the location hierachy, such as a bed room ward. Includes all fields of `CodeableConcept`. * `period` (_object_) Specifies the period during which the patient was present at the location. Includes all fields of `Period`. * `serviceProvider` (_object_) Specifies the custodian organization of the encounter record. Includes all fields of `Reference`. * `partOf` (_object_) Specifies another encounter this encounter is a part of. Includes all fields of `Reference`. ### Location Provides details and position information for a physical place. Elements defined in ancestors: id, meta, implicitRules, language, text, contained, extension, and modifierExtension. Includes all fields of `DomainResource`. * `identifier` (_array of Identifier_) Specifies the unique code or number identifying the location to its users. * `status` (_code (string)_) Specifies the status of the location. Possible values are active, suspended, and inactive. Allowed values: `active`, `suspended`, `inactive`. * `name` (_string_, required) Specifies the name of the location. * `description` (_string_) Provides additional details about the location that's displayed as further information to identify the location beyond its name. * `type` (_array of CodeableConcept_) Specifies the type of function that's performed. * `telecom` (_array of ContactPoint_) Specifies the contact details of the location. * `address` (_object_) Specifies the physical location details. Includes all fields of `Address`. * `physicalType` (_object_) Specifies the physical form of the location. Includes all fields of `CodeableConcept`. * `position` (_object_) Specifies the absolute geographic location. Includes all fields of `BackboneElement`. * `longitude` (_decimal (number)_, required) Specifies the longitude with the WGS84 datum. * `latitude` (_decimal (number)_, required) Specifies the latitude with the WGS84 datum. * `managingOrganization` (_object_) Specifies the organization responsible for the provisioning and maintenance. Includes all fields of `Reference`. * `partOf` (_object_) Specifies another location this location is physically a part of. Includes all fields of `Reference`. * `hoursOfOperation` (_array of object_) Specifies the days or times during the week when the location is open. Includes all fields of `BackboneElement`. * `daysOfWeek` (_array of code_) mon | tue | wed | thu | fri | sat | sun * `openingTime` (_time (string)_, required) Time that the Location opens * `closingTime` (_time (string)_, required) Specifies the time when the location closes. * `availabilityExceptions` (_string_) Provides description of the availability exceptions. ### OrganizationBundle Includes all fields of `Bundle`. * `entry` (_array of OrganizationEntry_) ### Organization Organization profile sets minimum expectations for the Organization resource to search for and fetch an organization associated with a patient or provider. The Organization profile identifies which core elements, extensions, vocabularies and value sets must be present in the resource when using this profile. Example Usage Scenarios: The following are example usage scenarios for the US Core-Organization profile: Query by organization name or NPI Mandatory and Must Support Data Elements The following data elements are mandatory. The data must be present or must be supported if the data is present in the sending system (Must Support definition). Presented in a simple human-readable explanation, the profile-specific guidance and examples are provided. This Formal Profile Definition provides the formal summary, definitions, and terminology requirements. Each Organization must have: A status of the organization. A name. Each Organization must support: An identifier. A list of contact information. An address. Includes all fields of `DomainResource`. * `identifier` (_array of object_) Identifies the organization across multiple systems. Includes all fields of `Identifier`. * `active` (_boolean_, required) Indicates whether the organization's record is still in active use (true) or not (false). * `type` (_array of CodeableConcept_) Specifies the kind of organization. * `name` (_string_, required) Specifies the name used for the organization. * `telecom` (_array of ContactPoint_) Specifies a contact detail for the organization. * `address` (_array of object_) Specifies an address of the organization. Includes all fields of `Address`. * `contact` (_array of object_) Specifies the contact for the organization. Includes all fields of `BackboneElement`. * `purpose` (_object_) The type of contact Binding: ContactEntityType (extensible) Includes all fields of `CodeableConcept`. * `name` (_object_) Specifies a name associated with the contact. Includes all fields of `HumanName`. * `telecom` (_array of ContactPoint_) Specifies the contact details for a contact, such as telephone, email. * `address` (_object_) Specifies the visiting or postal addresses of the contact. Includes all fields of `Address`. ### RelatedPersonBundle Includes all fields of `Bundle`. * `entry` (_array of RelatedPersonEntry_) ### RelatedPerson Specifies a person that's related to the patient, but who isn't a direct target of the care-related services. Elements defined in ancestors: id, meta, implicitRules, language, text, contained, extension, and modifierExtension. Includes all fields of `DomainResource`. * `active` (_boolean_, required) Indicates whether the related person's record is in active use (true) or not (false). * `patient` (_object_, required) Specifies the patient this person is related to. Includes all fields of `Reference`. * `relationship` (_array of CodeableConcept_) Specifies the nature of the relationship. * `name` (_array of HumanName_) Specifies the name of the related person. * `telecom` (_array of ContactPoint_) Specifies the contact details of the related person. * `gender` (_code (string)_) Specifies the gender of the related person. Possible values are male, female, other, and unknown. Allowed values: `male`, `female`, `other`, `unknown`. * `birthDate` (_date (string)_) Specifies the date of birth of the related person. * `address` (_array of Address_) Specifies the address where the related person can be contacted or visited. * `period` (_object_) Specifies the period when the relationship is considered valid. Includes all fields of `Period`. * `communication` (_array of object_) A language which may be used to communicate with about the patient's health Includes all fields of `BackboneElement`. * `language` (_object_, required) Specifies the language to communicate with the patient about their health. Includes all fields of `CodeableConcept`. * `preferred` (_boolean_) Specifies the language preference indicator. * `recordTypeLabel` (_string_) Specifies the record type in Salesforce. ### Bundle Includes all fields of `Resource`. * `type` (_code (string)_, required) Specifies the type of bundle. Possible values are document, message, transaction, transaction-response, batch, batch-response, history, searchset, and collection. Allowed values: `document`, `message`, `transaction`, `transaction-response`, `batch`, `batch-response`, `history`, `searchset`, `collection`. * `total` (_unsignedInt (integer)_) Specifies the number of matches with the search results. * `link` (_array of object_) Specifies the links related to the bundle. Includes all fields of `BackboneElement`. * `relation` (_string_, required) Specifies how this bundle link relates at the parent level. See [link relations](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). * `url` (_uri (string)_, required) Specifies the reference details for the link. * `entry` (_array of object_) Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version-specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. Includes all fields of `Entry`. ### PatientEntry Includes all fields of `Entry`. * `resource` (_Patient_, required) ### Resource Specifies the base resource. * `id` (_id (string)_) Specifies the logical ID of the artifact. * `meta` (_object_) Specifies the metadata of the resource. Includes all fields of `Meta`. ### code Indicates that the value is taken from a set of controlled strings defined elsewhere. See [Using codes](http://hl7.org/fhir/STU3/terminologies.html). Technically, a code is restricted to a string which has at least one character and no leading or trailing whitespace, and where there is no whitespace other than single spaces in the contents. Type: `string`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. ### CodeableConcept Represents a value that's usually supplied by providing a reference to one or more terminologies or ontologies, but can also be defined by the provision of text. CodeableConcept element is a common pattern in healthcare data. * `coding` (_array of Coding_) Specifies the code defined by a terminology system. * `text` (_string_) Specifies the plain text representation of the concept. ### DomainResource Specifies a resource with a narrative, the extensions, and the contained resources. * If the resource is contained in another resource, it must not contain nested resources. * If the resource is contained in another resource, it must not contain any narrative. * If a resource is contained in another resource, it must not have a meta.versionId or a meta.lastUpdated property. * If the resource is contained in another resource, it must be referred to from elsewhere in the resource. Includes all fields of `Resource`. ### Identifier Specifies a numeric or alphanumeric string that's associated with a single object or entity within a given system. Typically, identifiers are used to connect content in resources to external content available in other frameworks or protocols. Identifiers are associated with objects, and can be changed or retired due to human or system process and errors. * `use` (_code (string)_) Specifies the usage of the identifier. Possible values are usual, official, temp, and secondary, if known. Allowed values: `usual`, `official`, `temp`, `secondary`, `old`. * `system` (_uri (string)_) Specifies the namespace for the identifier value. * `value` (_string_) Specifies the unique value of the identifier. ### HumanName Specifies the name of the human with text, parts, and usage information. * `use` (_code (string)_) Allowed values: `usual`, `official`, `temp`, `nickname`, `anonymous`, `old`, `maiden`. * `text` (_string_) Specifies the text representation of the full name. * `family` (_string_) Specifies the family name, which is also often called 'Surname'. * `given` (_array of string_) Specifies the given names, which is not always first name and includes middle names. * `prefix` (_array of string_) Specifies the parts that appear before the name. * `suffix` (_array of string_) Specifies the parts that appear after the name. * `period` (_object_) Specifies the period when name was or is in use. Includes all fields of `Period`. ### ContactPoint Provides details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, and so on. * `system` (_code (string)_) Allowed values: `phone`, `fax`, `email`, `sms`, `pager`, `url`, `other`. * `value` (_string_) Specifies the actual contact point details. * `use` (_code (string)_) Specifies the purpose of the contact point. Allowed values: `home`, `work`, `temp`, `old`, `mobile`. * `rank` (_positiveInt (integer)_) Specifies the preferred order of use with 1 as highest rank. * `period` (_object_) Specifies the period when the contact point was or is in use. Includes all fields of `Period`. ### date Specifies a date or partial date as used in human communication wherein there's no time zone. Dates must be valid dates. For example, just year or year along with month. Type: `string`. Pattern: ^\[0-9\]{4}(-(0\[1-9\]|1\[0-2\])(-(0\[0-9\]|\[1-2\]\[0-9\]|3\[0-1\]))?)?$. Example: `1970-08-07`. ### patientdeceasedDateTime * `deceasedDateTime` (_dateTime (string)_) Specifies if the individual is deceased. ### patientmultipleBirthInteger * `multipleBirthInteger` (_integer_) Specifies whether the patient is a part of multiple births. ### Address Specifies the address expressed using postal conventions as opposed to GPS or other location definition formats. Address data type can be used to convey addresses for use in delivering mail and for visiting locations not valid for mail delivery. There are a variety of postal address formats defined around the world. * `use` (_code (string)_) Specifies the purpose of this address, such as home, work, temp, or old. Allowed values: `home`, `work`, `temp`, `old`, `billing`. * `line` (_array of string_, required) Specifies the street name, number, direction, P.O. Box, and so on. * `city` (_string_) Specifies the name of city or town. * `state` (_string_) Specifies the sub-unit of country wherein abbreviations are allowed. * `postalCode` (_string_) Specifies the postal code for the area. * `country` (_string_) Specifies the country, which can be an ISO 3166 2 or 3-letter code. * `period` (_object_) Specifies the period when address was or is in use. Includes all fields of `Period`. ### BackboneElement Includes all fields of `Element`. * `modifierExtension` (_array of Extension_) Specifies the modifier extensions. ### Period Specifies the period defined by a start and end date or time. * `start` (_dateTime (string)_) Specifies the starting time with inclusive boundary. * `end` (_dateTime (string)_) Specifies the end time with inclusive boundary, if not ongoing. ### Reference Many of the defined elements in a resource are references to other resources. Using these references, the resources combine to build a web of information about healthcare. * `reference` (_string_) Specifies the literal reference, relative, internal, or absolute URL. * `identifier` (_object_) Specifies the logical reference when literal reference is not known. Includes all fields of `Identifier`. * `display` (_string_) Specifies the text alternative for the resource. * `type` (_uri (string)_) Specifies the type the reference refers to. For example, a patient. ### PractitionerEntry Includes all fields of `Entry`. * `resource` (_Practitioner_, required) ### PractitionerRoleEntry Includes all fields of `Entry`. * `resource` (_PractitionerRole_, required) ### EncounterEntry Includes all fields of `Entry`. * `resource` (_Encounter_, required) ### Coding Represents a defined concept using a symbol from a defined code system. SSee [Using codes](http://hl7.org/fhir/STU3/terminologies.html). * `system` (_uri (string)_) Specifies the identity of the terminology system. * `version` (_string_) Specifies the version of the system, if relevant. * `code` (_code (string)_) Specifies the symbol in a syntax defined by the system. * `display` (_string_) Specifies the representation defined by the system. * `userSelected` (_boolean_) ### positiveInt Specifies any non-negative integer, which is >= 1. Regex - +?\[1-9\]\[0-9\]\* Type: `integer`. Minimum: 1. ### decimal Specifies rational numbers that have a decimal representation. Check the precision of the number HumanNameby using the regex: -?(0|\[1-9\]\[0-9\]\*)(.\[0-9\]+)?(\[eE\]\[+-\]?\[0-9\]+)? Type: `number`. ### time Specifies a time during the day with no date specified and can be converted to a duration since midnight. Seconds must be provided due to schema type constraints but can be zero-filled and can be ignored. The time "24:00" is not allowed, and neither is a time zone. Type: `string`. Pattern: ^(\[01\]\[0-9\]|2\[0-3\]):\[0-5\]\[0-9\]:\[0-5\]\[0-9\](https://./[0-9/]+)?$. ### OrganizationEntry Includes all fields of `Entry`. * `resource` (_Organization_, required) ### RelatedPersonEntry Includes all fields of `Entry`. * `resource` (_RelatedPerson_, required) ### unsignedInt Specifies any non-negative integer, which is >= 0. Regex - \[0\]|(\[1-9\]\[0-9\]\*) Type: `integer`. Minimum: 0. ### uri Specifies a Uniform Resource Identifier Reference. See [Uniform Resource Identifier](https://tools.ietf.org/html/rfc3986). Note: URIs are case-sensitive. For UUID (urn:uuid:53fefa32-fcbb-4ff8-8a92-55ee120877b7), use all lowercase. URIs can be absolute or relative, and can have an optional fragment identifier. Regex: \\S\* Type: `string`. ### Entry Entry in the bundle must have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl property can't be a version specific reference. For bundles of 'document' and 'message' type, the first resource is special and must be the Composition or MessageHeader properties respectively. For all bundles, the meaning of the order of entries depends on the bundle type. Includes all fields of `BackboneElement`. * `resource` (_object_) Specifies a resource in the bundle. Includes all fields of `Resource`. * `fullUrl` (_uri (string)_) Specifies the URI for the resource, which is the absolute URL server address, or URI for UUID or OID. * `search` (_object_) Specifies the search-related information. Includes all fields of `BackboneElement`. * `mode` (_code (string)_) Specifies why the entry is in the result set. Possible values are match, include, and outcome. Allowed values: `match`, `include`, `outcome`. ### Meta Each resource contains an element 'meta' of type 'Meta', which is a set of metadata that provides technical and workflow context to the resource. The metadata items are optional, though some or all of them may be required in particular implementations or contexts of use. * `versionId` (_id (string)_) Specifies the version specific identifier. * `lastUpdated` (_instant (string)_) Specifies when the resource version last changed. * `source` (_uri (string)_) Specifies the source of the resource. * `profile` (_array of canonical_) Specifies the profiles the resource claims to conform to. * `security` (_array of Coding_) Specifies the security labels applied to the resource. * `tag` (_array of Coding_) Specifies the tags applied to the resource. ### dateTime Specifies a date, dateTime, or partial date as used in human communication. If hours and minutes are specified, a time zone is populated. For example, just year or year along with month. Seconds must be provided due to schema type constraints but can be zero-filled and can be ignored. Dates must be valid dates. The time "24:00" is not allowed. Type: `string`. Pattern: ^\[0-9\]{4}(-(0\[1-9\]|1\[0-2\])(-(0\[0-9\]|\[1-2\]\[0-9\]|3\[0-1\])(T(\[01\]\[0-9\]|2\[0-3\]):\[0-5\]\[0-9\]:\[0-5\]\[0-9\](https://./[0-9/]+)?(Z|(\\+|-)((0\[0-9\]|1\[0-3\]):\[0-5\]\[0-9\]|14:00)))?)?)?$. ### Element * `id` (_id (string)_) Specifies the internal ID of the element. * `extension` (_array of Extension_) Additional Content defined by implementations - from Element: extension (recursive) ### Extension Optional. Extensions Element + Rule must have extensions or value\[x\], but not both elements defined in ancestors id or extension. Includes all fields of `Element`. * `url` (_uri (string)_, required) Identifies the meaning of the extension. * `value` (_enumvalueInteger | enumvalueDecimal | enumvalueDateTime | enumvalueDate | enumvalueInstant | enumvalueString | enumvalueUri | enumvalueBoolean | enumvalueCode | enumvalueBase64Binary | enumvalueCoding | enumvalueCodeableConcept | enumvalueAttachment | enumvalueIdentifier | enumvalueQuantity | enumvalueRange | enumvaluePeriod | enumvalueRatio | enumvalueHumanName | enumvalueAddress | enumvalueContactPoint | enumvalueReference | enumvalueCanonical | enumvalueId | enumvalueMarkdown | enumvalueOid | enumvaluePositiveInt | enumvalueTime | enumvalueUnsignedInt | enumvalueUrl | enumvalueUuid | enumvalueAge | enumvalueAnnotation | enumvalueCount | enumvalueDistance | enumvalueDuration | enumvalueMoney | enumvalueSampledData | enumvalueSignature | enumvalueTiming | enumvalueContactDetail | enumvalueContributor | enumvalueDataRequirement | enumvalueExpression | enumvalueParameterDefinition | enumvalueRelatedArtifact | enumvalueTriggerDefinition | enumvalueUsageContext | enumvalueDosage | enumvalueMeta_) Value of extension One of: `enumvalueInteger`, `enumvalueDecimal`, `enumvalueDateTime`, `enumvalueDate`, `enumvalueInstant`, `enumvalueString`, `enumvalueUri`, `enumvalueBoolean`, `enumvalueCode`, `enumvalueBase64Binary`, `enumvalueCoding`, `enumvalueCodeableConcept`, `enumvalueAttachment`, `enumvalueIdentifier`, `enumvalueQuantity`, `enumvalueRange`, `enumvaluePeriod`, `enumvalueRatio`, `enumvalueHumanName`, `enumvalueAddress`, `enumvalueContactPoint`, `enumvalueReference`, `enumvalueCanonical`, `enumvalueId`, `enumvalueMarkdown`, `enumvalueOid`, `enumvaluePositiveInt`, `enumvalueTime`, `enumvalueUnsignedInt`, `enumvalueUrl`, `enumvalueUuid`, `enumvalueAge`, `enumvalueAnnotation`, `enumvalueCount`, `enumvalueDistance`, `enumvalueDuration`, `enumvalueMoney`, `enumvalueSampledData`, `enumvalueSignature`, `enumvalueTiming`, `enumvalueContactDetail`, `enumvalueContributor`, `enumvalueDataRequirement`, `enumvalueExpression`, `enumvalueParameterDefinition`, `enumvalueRelatedArtifact`, `enumvalueTriggerDefinition`, `enumvalueUsageContext`, `enumvalueDosage`, `enumvalueMeta`. ### instant Specifies an instant in time that's known at least to the second and always includes a time zone. Note: This is intended for precisely observed times, such as system logs, and not human-reported time. For human-reported time, use date and dateTime. Instant is a more constrained dateTime type. Note: Instant type is for system times, not human times (see date and dateTime). Type: `string`. ### canonical Specifies a URI that refers to a resource by its canonical URL (resources with a url property). The canonical type differs from a URI wherein it has a special meaning in the specification. The URI can have a version appended, separated by a vertical bar (|). Note that the type canonical is not used for the actual canonical URLs that are the target of these references, but for the URIs that refer to them, and can have the version suffix in them. Like other URIs, elements of type canonical can also have #fragment references. Type: `uri (string)`. ### enumvalueInteger * `valueInteger` (_integer_, required) Specifies the value of the extension. ### enumvalueDecimal * `valueDecimal` (_decimal (number)_, required) Specifies the decimal value of the extension. ### enumvalueDateTime * `valueDateTime` (_dateTime (string)_, required) Specifies the DateTime value of the extension. ### enumvalueDate * `valueDate` (_date (string)_, required) Specifies the Date value of the extension. ### enumvalueInstant * `valueInstant` (_instant (string)_, required) Specifies the instant value of the extension. ### enumvalueString * `valueString` (_string_, required) Specifies the string value of the extension. ### enumvalueUri * `valueUri` (_uri (string)_, required) Specifies the URI value of the extension. ### enumvalueBoolean * `valueBoolean` (_boolean_, required) Specifies the boolean value of the extension. ### enumvalueCode * `valueCode` (_code (string)_, required) Specifies the code value of the extension. ### enumvalueBase64Binary * `valueBase64Binary` (_base64Binary (string)_, required) Specifies the Base64 value of the extension. ### enumvalueCoding * `valueCoding` (_object_, required) Specifies the coding value of the extension. Includes all fields of `Coding`. ### enumvalueCodeableConcept * `valueCodeableConcept` (_object_, required) Specifies the CodeableConcept value of the extension. Includes all fields of `CodeableConcept`. ### enumvalueAttachment * `valueAttachment` (_object_, required) Specifies the attachment value of the extension. Includes all fields of `Attachment`. ### enumvalueIdentifier * `valueIdentifier` (_object_, required) Specifies the identifier value of the extension. Includes all fields of `Identifier`. ### enumvalueQuantity * `valueQuantity` (_object_, required) Specifies the quantity value of the extension. Includes all fields of `Quantity`. ### enumvalueRange * `valueRange` (_object_, required) Specifies the range value of the extension. Includes all fields of `Range`. ### enumvaluePeriod * `valuePeriod` (_object_, required) Specifies the period of the extension. Includes all fields of `Period`. ### enumvalueRatio * `valueRatio` (_object_, required) Specifies the ratio of the extension. Includes all fields of `Range`. ### enumvalueHumanName * `valueHumanName` (_object_, required) Specifies the HumanName value of the extension. Includes all fields of `HumanName`. ### enumvalueAddress * `valueAddress` (_object_, required) Specifies the address value of the extension. Includes all fields of `Address`. ### enumvalueContactPoint * `valueContactPoint` (_object_, required) Specifies the contact point value of the extension. Includes all fields of `ContactPoint`. ### enumvalueReference * `valueReference` (_object_, required) Specifies the reference value of the extension. Includes all fields of `Reference`. ### enumvalueCanonical * `valueCanonical` (_canonical (string)_, required) Specifies the canonical value of the extension. ### enumvalueId * `valueId` (_id (string)_, required) Specifies the value ID of the extension. ### enumvalueMarkdown * `valueMarkdown` (_markdown (string)_, required) Specifies the markdown value of the extension. ### enumvalueOid * `valueOid` (_oid (string)_, required) Specifies the OID value of the extension. ### enumvaluePositiveInt * `valuePositiveInt` (_positiveInt (integer)_, required) Specifies the positive integer value of the extension. ### enumvalueTime * `valueTime` (_time (string)_, required) Specifies the time value of the extension. ### enumvalueUnsignedInt * `valueUnsignedInt` (_unsignedInt (integer)_, required) Specifies the unsigned integer value of the extension. ### enumvalueUrl * `valueUrl` (_url (string)_, required) Specifies the URL value of the extension. ### enumvalueUuid * `valueUuid` (_uuid (string)_, required) Specifies the UUID value of the extension. ### enumvalueAge * `valueAge` (_any_, required) Specifies the age value of the extension. ### enumvalueAnnotation * `valueAnnotation` (_object_, required) Specifies the annotation value of the extension. Includes all fields of `Annotation`. ### enumvalueCount * `valueCount` (_any_, required) Specifies the count value of the extension. ### enumvalueDistance * `valueDistance` (_any_, required) Specifies the distance value of the extension. ### enumvalueDuration * `valueDuration` (_any_, required) Specifies the duration value of the extension. ### enumvalueMoney * `valueMoney` (_object_, required) Specifies the money value of the extension. Includes all fields of `Money`. ### enumvalueSampledData * `valueSampledData` (_object_, required) Specifies the sample data value of the extension. Includes all fields of `SampledData`. ### enumvalueSignature * `valueSignature` (_object_, required) Specifies the signature value of the extension. Includes all fields of `Signature`. ### enumvalueTiming * `valueTiming` (_object_, required) Specifies the timing value of the extension. Includes all fields of `Timing`. ### enumvalueContactDetail * `valueContactDetail` (_object_, required) Specifies the contact detail value of the extension. Includes all fields of `ContactDetail`. ### enumvalueContributor * `valueContributor` (_object_, required) Specifies the contributor value of the extension. Includes all fields of `Contributor`. ### enumvalueDataRequirement * `valueDataRequirement` (_object_, required) Specifies the signature value of the extension. Includes all fields of `DataRequirement`. ### enumvalueExpression * `valueExpression` (_object_, required) Specifies the expression value of the extension. Includes all fields of `Expression`. ### enumvalueParameterDefinition * `valueParameterDefinition` (_object_, required) Specifies the parameter definition value of the extension. Includes all fields of `ParameterDefinition`. ### enumvalueRelatedArtifact * `valueRelatedArtifact` (_object_, required) Specifies the related artifact value of the extension. Includes all fields of `RelatedArtifact`. ### enumvalueTriggerDefinition * `valueTriggerDefinition` (_object_, required) Specifies the trigger definition value of the extension. Includes all fields of `TriggerDefinition`. ### enumvalueUsageContext * `valueUsageContext` (_object_, required) Specifies the usage context value of the extension. Includes all fields of `UsageContext`. ### enumvalueDosage * `valueDosage` (_object_, required) Specifies the dosage value of the extension. Includes all fields of `Dosage`. ### enumvalueMeta * `valueMeta` (_object_, required) Specifies the meta value of the extension. Includes all fields of `Meta`. ### base64Binary There's no specified upper limit to the size of a binary, but systems will impose some implementation-based limit to the size they support. This requires clear documentation, though there's no computable for the binary at this time. Type: `string`. Pattern: ^(\\s\*(\[0-9a-zA-Z\\+\\=\]){4}\\s\*)+$. ### Attachment Specifies containing or referencing attachments - additional data content defined in other formats. The most common use of the attachment type is to include images or reports in some report format, such as PDF. However, it can be used for any data that has a MIME type. * `contentType` (_code (string)_) Specifies the mime type of the content, such as charset. * `language` (_code (string)_) Specifies the human language of the content (BCP-47). * `data` (_base64Binary (string)_) Specifies the base64ed data inline. * `url` (_uri (string)_) Specifies the URI where the data can be found. * `size` (_unsignedInt (integer)_) Specifies the number of bytes of content if URL is provided. * `hash` (_base64Binary (string)_) Specifies the hash of the data, such as SHA-1 or base64ed. * `title` (_string_) Specifies the label to display in place of the data. * `creation` (_dateTime (string)_) Specifies the date when the attachment was first created. ### Quantity Specifies a measured amount or an amount that can potentially be measured. * `value` (_decimal (number)_) Specifies the numerical value with implicit precision. * `comparator` (_code (string)_) Specifies how to understand the numerical value. Allowed values: `<`, `<=`, `>=`, `>`. * `unit` (_string_) Specifies the unit representation. * `system` (_uri (string)_) Specifies the system that defines a coded unit form. * `code` (_code (string)_) Specifies the coded form of the unit. ### Range Specifies a set of ordered quantity values defined by a low and high limit. * `low` (_object_) Specifies the lower limit. Includes all fields of `Quantity`. * `high` (_object_) Specifies the higher limit. Includes all fields of `Quantity`. ### markdown A FHIR string that can contain markdown syntax for optional processing by a markdown presentation engine, in the GFM extension of CommonMark format. Type: `string`. Pattern: ^\\s\*(\\S|\\s)\*$. ### oid An OID is represented as a URI (RFC 3001). For example, urn:oid:1.2.3.4.5. Type: `string`. Pattern: ^urn:oid:\[0-2\](\\.(0|\[1-9\]\[0-9\]\*))+$. ### url Specifies a Uniform Resource Locator (RFC 1738). Note: URLs are accessed directly using the specified protocol. Common URL protocols are http{s}:, ftp:, mailto: and mllp:, though many others are defined. Type: `string`. ### uuid A UUID (aka GUID) is represented as a URI (RFC 4122). For example, urn:uuid:c757873d-ec9a-4326-a141-556f43239520. Type: `string`. Pattern: ^urn:uuid:^\[0-9a-fA-F\]{8}-\[0-9a-fA-F\]{4}-\[0-9a-fA-F\]{4}-\[0-9a-fA-F\]{4}-\[0-9a-fA-F\]{12}$. ### Annotation Specifies the text note which also contains information about who made the statement and when. * `author` (_annotationauthorReference | annotationauthorString_) Specifies the individual responsible for the annotation. One of: `annotationauthorReference`, `annotationauthorString`. * `time` (_dateTime (string)_) Specifies when the annotation was made. * `text` (_string_, required) Specifies the text content of the annotation. ### Money Specifies an amount of economic utility in some recognized currency elements, defined in Ancestors: id, extension. * `value` (_decimal (number)_) Specifies the numerical value with implicit precision. * `currency` (_code (string)_) Specifies the ISO 4217 currency code. Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TVD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XSU`, `XTS`, `XUA`, `XXX`, `YER`, `ZAR`, `ZMW`, `ZWL`. ### SampledData Specifies a series of measurements taken by a device. * `origin` (_object_, required) Specifies the zero value and units. Includes all fields of `Quantity`. * `period` (_decimal (number)_, required) Specifies the number of milliseconds between samples. * `factor` (_decimal (number)_) Specifies the factor wherein you multiply data by factor before adding to origin. * `lowerLimit` (_decimal (number)_) Specifies the lower limit of detection. * `upperLimit` (_decimal (number)_) Specifies the upper limit of detection. * `dimensions` (_positiveInt (integer)_, required) Specifies the number of sample points at each time point. * `data` (_string_, required) Specifies the decimal values with spaces. Possible values are E, U, or L. Allowed values: `E`, `U`, `L`. ### Signature Holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature can be a cryptographic type (XML DigSig or a JWT), which is able to provide non-repudiation proof, or it can be a graphical image that represents a signature or a signature process. * `type` (_array of Coding_, required) Specifies the reason the entity signed one or more objects. * `when` (_instant (string)_, required) Specifies when the signature was created. * `who` (_object_) Specifies who signed the object. Includes all fields of `Reference`. * `onBehalfOf` (_object_) Specifies the party representation. Includes all fields of `Reference`. * `targetFormat` (_code (string)_) Specifies the technical format of the signed resources. * `sigFormat` (_code (string)_) Specifies the technical format of the signature. * `data` (_base64Binary (string)_) Specifies the actual signature content, such as XML DigSig. JWT, or picture. ### Timing Specifies an event that can occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur and can also be used to represent a schedule that was followed for past events. A timing schedule can be a list of events and criteria for when the event happens, which can be expressed in a structured form and as a code. When both event and a repeating specification are provided, the list of events must be understood as an interpretation of the information in the repeat structure. * `event` (_array of dateTime_) Specifies when the event occurs. * `repeat` (_object_) Specifies when the event is to occur. Includes all fields of `Element`. * `bounds` (_timingboundsDuration | timingboundsRange | timingboundsPeriod_) Specifies the range of lengths or start and end limits. One of: `timingboundsDuration`, `timingboundsRange`, `timingboundsPeriod`. * `count` (_positiveInt (integer)_) Specifies the number of times to repeat. * `countMax` (_positiveInt (integer)_) Specifies the maximum number of times to repeat. * `duration` (_decimal (number)_) Specifies the duration of the event. * `durationMax` (_decimal (number)_) Specifies the maximum duration of the event. * `durationUnit` (_UnitOfTime (string)_) Specifies a unit of time (UCUM) in seconds, minutes, hours, days, weeks, months, or years. Possible values are s, min, h, d, wk, mo, or a. * `frequency` (_positiveInt (integer)_) Specifies the frequency wherein the event occurs frequency times per period. * `frequencyMax` (_positiveInt (integer)_) Specifies the maximum frequency wherein the event occurs up to frequencyMax times per period. * `period` (_decimal (number)_) Specifies the period wherein the event occurs frequency times per period. * `periodMax` (_decimal (number)_) Specifies the upper limit of period (3-4 hours). * `periodUnit` (_UnitOfTime (string)_) Specifies a unit of time (UCUM) in seconds, minutes, hours, days, weeks, months, or years. Possible values are s, min, h, d, wk, mo, or a. Allowed values: `s`, `min`, `h`, `d`, `wk`, `mo`, `a`. * `dayOfWeek` (_code (string)_) mon | tue | wed | thu | fri | sat | sun Allowed values: `mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `sun`. * `timeOfDay` (_time (string)_, required) Specifies the time of day for action. * `when` (_code (string)_) Specifies the regular life events the event is tied to. Allowed values: `HS`, `WAKE`, `C`, `CM`, `CD`, `CV`, `AC`, `ACM`, `ACD`, `ACV`, `PC`, `PCM`, `PCD`, `PCV`. * `offset` (_unsignedInt (integer)_, required) Specifies the minutes from event (before or after). * `code` (_object_) BID | TID | QID | AM | PM | QD | QOD | Q1H | Q2H | Q3H | Q4H | Q6H | Q8H | BED | WK | MO Includes all fields of `CodeableConcept`. ### ContactDetail Specifies the contact information for elements defined in ancestors: id, extension. * `name` (_string_) Specifies the name of an individual to contact. * `telecom` (_array of ContactPoint_) Specifies the contact details of an individual or organization. ### Contributor Provides contributor details for elements defined in ancestors id and extension. * `type` (_code (string)_, required) author | editor | reviewer | endorser Allowed values: `author`, `editor`, `reviewer`, `endorser`. * `name` (_string_, required) Specifies who contributed to the content. * `contact` (_array of ContactDetail_) Specifies contact details of the contributor. ### DataRequirement Describes the required data item for elements defined in ancestors id or extension. * `type` (_code (string)_, required) Specifies the type of the required data. * `profile` (_array of canonical_) Specifies the profile of the required data. * `subject` (_dataRequirementssubjectCodeableConcept | dataRequirementssubjectReference_) Specifies the subject, such as a Patient, Practitioner, RelatedPerson, Organization, Location, or Device. One of: `dataRequirementssubjectCodeableConcept`, `dataRequirementssubjectReference`. * `mustSupport` (_array of string_) Specifies the specific structure elements that are referenced by the knowledge module. * `codeFilter` (_array of object_) Specifies the codes are expected. + Rule - Requires a path or a searchParam property, but not both. Includes all fields of `Element`. * `path` (_string_) Specifies a code-valued attribute to filter codes. * `searchParam` (_string_) Specifies a coded (token) parameter for search operation. * `valueSet` (_canonical (string)_) Specifies the value set for the filter. * `code` (_array of Coding_) Specifies the expected code. * `dateFilter` (_array of object_) Includes all fields of `Element`. * `path` (_string_) Specifies a date-valued attribute to filter dates. * `searchParam` (_string_) Specifies a date-valued parameter for search operation. * `value` (_enumvalueDateTime | enumvaluePeriod | enumvalueDuration_) Specifies the value of the filter, such as a Period, DateTime, or Duration value. One of: `enumvalueDateTime`, `enumvaluePeriod`, `enumvalueDuration`. * `limit` (_positiveInt (integer)_) Specifies the number of results. * `sort` (_array of object_) Specifies the order of the results. Includes all fields of `Element`. * `path` (_string_, required) Specifies the name of the attribute to perform the sort operation. * `direction` (_code (string)_, required) ascending | descending Allowed values: `ascending`, `descending`. ### Expression Specifies an expression that can be used to generate a value. * Rule: An expression or a reference must be provided. Elements defined in Ancestors: id, extension. * `description` (_string_) Specifies the natural language description of the condition. * `name` (_id (string)_) Specifies the short name assigned to the expression for reuse. * `language` (_code (string)_, required) text/cql | text/fhirpath | application/x-fhir-query Allowed values: `text/cql`, `text/fhirpath`, `application/x-fhir-query`. * `expression` (_string_) Specifies the expression in a specified language. * `reference` (_uri (string)_) Specifies where the expression is found. ### ParameterDefinition Definition of a parameter to a module. Elements defined in Ancestors: id, extension. * `name` (_code (string)_) Specifies the name used to access the parameter value. * `use` (_code (string)_, required) in | out Allowed values: `in`, `out`. * `min` (_integer_) Specifies the minimum cardinality. * `max` (_string_) Specifies the maximum cardinality (a number of \*). * `documentation` (_string_) Specifies a brief description of the parameter. * `type` (_code (string)_) * `profile` (_canonical (string)_) Specifies what profile the value is expected to be. ### RelatedArtifact Specifies related artifacts for a knowledge resource. Elements defined in Ancestors: id, extension. * `type` (_code (string)_, required) documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Allowed values: `documentation`, `justification`, `citation`, `predecessor`, `successor`, `derived-from`, `depends-on`, `composed-of`. * `label` (_string_) Specifies a short label. * `display` (_string_) Specifies a brief description of the related artifact. * `citation` (_markdown (string)_) Specifies the bibliographic citation for the artifact. * `url` (_url (string)_) Specifies where the artifact can be accessed. * `document` (_object_) Specifies what document is being referenced. Includes all fields of `Attachment`. * `resource` (_canonical (string)_) Specifies what resource is being referenced. ### TriggerDefinition Defines an expected trigger for a module rule. Requires timing, or a data requirement, but not both. * Rule - A condition only if there's a data requirement * Rule A - A named event requires a name, a periodic event requires timing, and a data event requires data elements defined in ancestors id and extension. * `type` (_code (string)_, required) named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Allowed values: `named-event`, `periodic`, `data-changed`, `data-added`, `data-modified`, `data-removed`, `data-accessed`, `data-access-ended`. * `name` (_string_) Specifies the name or URI that identifies the event. * `timing` (_triggerDefinitiontimingTiming | triggerDefinitiontimingReference | triggerDefinitiontimingDate | triggerDefinitiontimingDateTime_) Specifies the timing of the event. One of: `triggerDefinitiontimingTiming`, `triggerDefinitiontimingReference`, `triggerDefinitiontimingDate`, `triggerDefinitiontimingDateTime`. * `data` (_array of DataRequirement_) Specifies the triggering data of the event (multiple = 'and'). * `condition` (_object_) Specifies the condition when the event triggers (boolean expression). Includes all fields of `Expression`. ### UsageContext Describes the context of use for a conformance or knowledge resource. Elements defined in ancestors id and extension. Includes all fields of `Element`. * `code` (_object_, required) Specifies the type of context being specified. Includes all fields of `Coding`. * `value` (_enumvalueCodeableConcept | enumvalueQuantity | enumvalueRange | enumvalueReference_, required) Specifies the value that defines the context. One of: `enumvalueCodeableConcept`, `enumvalueQuantity`, `enumvalueRange`, `enumvalueReference`. ### Dosage Specifies how the medication is taken or must be taken. Includes all fields of `BackboneElement`. * `sequence` (_integer_) Specifies the order of the dosage instructions. * `text` (_string_) Specifies the free text dosage instructions, such as SIG. * `additionalInstruction` (_array of CodeableConcept_) Specifies supplemental instructions. For example, "with meals" instruction. * `patientInstruction` (_string_) Specifies the patient or consumer-oriented instructions. * `timing` (_object_) Specifies when the medication must be administered. Includes all fields of `Timing`. * `asNeeded` (_dosageAsNeededBoolean | dosageAsNeededCodeableConcept_) Indicates whether the medication is only taken when required within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the medication (CodeableConcept). One of: `dosageAsNeededBoolean`, `dosageAsNeededCodeableConcept`. * `site` (_object_) Specifies the body site to administer to. Includes all fields of `CodeableConcept`. * `route` (_object_) Specifies how drug should enter the body. Includes all fields of `CodeableConcept`. * `method` (_object_) Specifies the technique for administering the medication. Includes all fields of `CodeableConcept`. * `doseAndRate` (_array of object_) Includes all fields of `Element`. * `type` (_object_, required) Specifies the kind of dose or rate specified. Includes all fields of `CodeableConcept`. * `dose` (_dosageDoseRange | dosageDoseQuantity_) Specifies the amount of medication per dose. One of: `dosageDoseRange`, `dosageDoseQuantity`. * `rate` (_dosageRateRatio | dosageRateRange | dosageRateQuantity_) Specifies the amount of medication per unit of time. One of: `dosageRateRatio`, `dosageRateRange`, `dosageRateQuantity`. * `maxDosePerPeriod` (_object_) Specifies the upper limit on medication per unit of time. Includes all fields of `Ratio`. * `maxDosePerAdministration` (_any_) Specifies the upper limit on medication per administration. * `maxDosePerLifetime` (_any_) Specifies the upper limit on medication per lifetime of the patient. ### annotationauthorReference * `authorReference` (_object_, required) Specifies the individual responsible for the annotation. Includes all fields of `Reference`. ### annotationauthorString * `authorString` (_string_, required) Specifies the individual responsible for the annotation. ### timingboundsDuration * `boundsDuration` (_any_, required) Specifies the range of lengths or start and end limits. ### timingboundsRange * `boundsRange` (_object_, required) Specifies the range of lengths or start and end limits. Includes all fields of `Range`. ### timingboundsPeriod * `boundsPeriod` (_object_, required) Specifies the range of lengths or start and end limits. Includes all fields of `Period`. ### UnitOfTime Specifies a unit of time (UCUM). Type: `code (string)`. Allowed values: `s`, `min`, `h`, `d`, `wk`, `mo`, `a`. ### dataRequirementssubjectCodeableConcept * `subjectCodeableConcept` (_object_, required) Specifies the subject, such as a Patient, Practitioner, RelatedPerson, Organization, Location, or Device. Includes all fields of `CodeableConcept`. ### dataRequirementssubjectReference * `subjectReference` (_object_, required) Specifies the subject reference, such as a Patient, Practitioner, RelatedPerson, Organization, Location, or Device. Includes all fields of `Reference`. ### triggerDefinitiontimingTiming * `timingTiming` (_object_, required) Specifies the timing of the event Includes all fields of `Timing`. ### triggerDefinitiontimingReference * `timingReference` (_object_, required) Specifies the timing of the event. Includes all fields of `Reference`. ### triggerDefinitiontimingDate * `timingDate` (_date (string)_, required) Specifies the timing of the event. ### triggerDefinitiontimingDateTime * `timingDateTime` (_dateTime (string)_, required) Specifies the timing of the event. ### dosageAsNeededBoolean * `asNeededBoolean` (_boolean_, required) Indicates whether the Medication is only taken when needed within a specific dosing schedule (true) or not (false). ### dosageAsNeededCodeableConcept * `asNeededCodeableConcept` (_object_, required) Indicates the precondition for taking the Medication (CodeableConcept). Includes all fields of `CodeableConcept`. ### dosageDoseRange * `doseRange` (_object_) Specifies the amount of medication per dose. Includes all fields of `Range`. ### dosageDoseQuantity * `doseQuantity` (_any_) Specifies the amount of medication per dose. ### dosageRateRatio * `rateRatio` (_object_) Specifies the amount of medication per unit of time. Includes all fields of `Ratio`. ### dosageRateRange * `rateRange` (_object_) Specifies the amount of medication per unit of time. Includes all fields of `Range`. ### dosageRateQuantity * `rateQuantity` (_any_) Specifies the amount of medication per unit of time. ### Ratio Specifies the relationship between two quantity values expressed as a numerator and a denominator. Includes all fields of `Element`. * `numerator` (_object_) Specifies the numerator value. Includes all fields of `Quantity`. * `denominator` (_object_) Specifies the denominator value. Includes all fields of `Quantity`.