--- schema_version: "1" id: 2f0070c90ea0a4eb083a2d0219db70b3a6ee3ac284a99404c4ac10fc00268f5e title: Clinical Summary collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/health/references/generated-api-specs/clinical_summary.md canonical_url: https://developer.salesforce.com/docs/industries/health/references/clinical_summary source_site: developer.salesforce.com content_type: documentation content_hash: 00883918afd3aa9f95f87370560307355ce174d146fc8ab2793309522a2bc76f products: - Salesforce Healthcare API - Industries Integrations --- Clinical Summary # Clinical Summary Use the Clinical Summary APIs to manage a patient's clinically assessed allergy or intolerance, condition, or procedure. You can create, update, or retrieve the AllergyIntolerance, HealthCondition, or PatientMedicalProcedure records for a patient from Salesforce Health Cloud. The [AllergyIntolerance](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_AllergyIntolerance.htm), [Condition](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_HealthCondition.htm), and [Procedure](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_patientmedicalprocedure.htm) FHIR resource maps to the Allergy​Intolerance, HealthCondition, and PatientMedicalProcedure objects in Salesforce respectively. **Version:** v1 Protocols: https. ## Operations ### GET Get conditions for a patient `GET /Condition` Retrieves a set of records by using filters. #### Parameters * `patient` (query, string) Specifies the ID of the patient with the condition. * `X-CORRELATION-ID` (header, string) #### Responses * **200** Request is successful. Media type: `application/fhir+json`. Schema: `ConditionBundle (extended)`. Contains a collection of resources. * Rule: total only for search results or history. * Rule: entry.search only for a search request. * Rule: entry.request mandatory for batch, transaction, or history, otherwise prohibited. * Rule: entry.response mandatory for batch-response, transaction-response, or history, otherwise prohibited. * Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles). * Rule: A document must have an identifier with a system and a value. * Rule: A document must have a date. * Rule: A document must have a Composition as the first resource. * Rule: A message must have a MessageHeader as the first resource. Elements defined in Ancestors: id, meta, implicitRules, or language. Includes all fields of `ConditionBundle`. * `entry` (_array of object_) Entry in the bundle - will have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl can't be a version specific reference. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type. Each item: Entry in the bundle - will have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl cannot be a version specific reference. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type. * `fullUrl` (_string_) The URI for the resource (Absolute URL server address or URI for UUID/OID). * `resource` (_object_, required) Specifies the base resource. * `abatement​Date​Time` (_string_) Specifies when the condition is in resolution or remission. 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)))?)?)?$. * `subject` (_object_, required) Specifies who has the condition. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `clinicalStatus` (_object_) Specifies the clinical status of the condition. Possible values are active, recurrence, inactive, remission, or resolved. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `code` (_object_, required) Identifies the condition, such as a problem or diagnosis. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `identifier` (_array of object_) Specifies the external IDs for this condition. Each item: A numeric or alphanumeric string that is related to 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 may be changed or retired due to human or system process and errors. * `use` (_string_) usual | official | temp | secondary (If known) Allowed values: `usual`, `official`, `temp`, `secondary`, `old`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `type` (_object_) Provides the description of Identifier. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `system` (_string_) Provides the namespace for Identifier value. * `value` (_string_) Specifies the ID value of Identifier. * `bodySite` (_array of object_) Specifies the anatomical location, if relevant. Each item: A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text. This is a common pattern in healthcare data. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `asserter` (_object_) Specifies the person who asserts the condition. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `recordedDate` (_string_) Specifies the date record when the condition was believed to be accurate. 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)))?)?)?$. * `id` (_string_) Specifies the ID of the base resource. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `encounter` (_object_) Specifies the encounter or episode when the condition first asserted. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `onsetDateTime` (_string_) Specifies the estimated or actual date, datetime, or age of the condition. 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)))?)?)?$. * `recorder` (_object_) Specifies the person who recorded the condition. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `category` (_array of object_, required) Specifies the category of the condition. Possible values are problem-list-item or encounter-diagnosis. Each item: A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text. This is a common pattern in healthcare data. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `stage` (_array of object_) Specifies the stage or grade, which is usually assessed formally. * Stage SHALL have summary. * `summary` (_object_) Specifies the disease-specific simple summary. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `severity` (_object_) Specifies the subjective severity of the condition. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `verificationStatus` (_object_) Specifies the verification status of the condition. Possible values are provisional, differential, confirmed, refuted, entered-in-error, or unconfirmed. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `search` (_object_) Provides the search-related information. * `mode` (_string_) Specifies the search mode and criteria. Possible values are match, include, or outcome. Allowed values: `match`, `include`, `outcome`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. _Example_ ``` { "resourceType": "Bundle", "id": "d774d2dd-5583-4264-a710-37d6e458f7dd", "meta": { "lastUpdated": "2023-08-08T10:22:29.869Z" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Condition" } ], "entry": [ { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Condition/0j4RO0000000DpZYAU", "search": { "mode": "match" }, "resource": { "resourceType": "Condition", "id": "0j4RO0000000DpZYAU", "identifier": [ { "value": "-4435348746", "system": "CMS Blue Button 2.0" } ], "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "principal", "display": "principal" } ] } ], "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "71945", "display": "JOINT PAIN-PELVIS" } ], "text": "Condition CODE Bundle" }, "subject": { "reference": "Patient/001RO00000AzQZ9YAN" }, "encounter": { "reference": "Encounter/0kGRO0000000KLb2AM" }, "recordedDate": "2015-04-01T00:00:00.000Z" } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Condition/0j4RO0000000DpaYAE", "search": { "mode": "match" }, "resource": { "resourceType": "Condition", "id": "0j4RO0000000DpaYAE", "identifier": [ { "value": "-4204873950", "system": "CMS Blue Button 2.0" } ], "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "principal", "display": "principal" } ] } ], "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "2724", "display": "HYPERLIPIDEMIA NEC/NOS" } ], "text": "Condition CODE Bundle" }, "subject": { "reference": "Patient/001RO00000AzQZ9YAN" }, "encounter": { "reference": "Encounter/0kGRO0000000KLl2AM" }, "recordedDate": "2014-05-01T00:00:00.000Z" } } ] } ``` * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example_ ``` { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "text": "Clinical Encounter ID: id value of incorrect type: 0kGB00PCRTMA4, The transaction was rolled back since another operation in the same transaction failed., The transaction was rolled back since another operation in the same transaction failed., The transaction was rolled back since another operation in the same transaction failed." } } ] } ``` ### POST Create a condition record `POST /Condition` Creates a record in the AllergyIntolerance, HealthCondition, or PatientMedicalProcedure object as per the clinical summary API request. #### Parameters * `X-CORRELATION-ID` (header, string) * `Accept` (header, string) Allowed values: `application/fhir+json`. #### Request body Media type: `application/fhir+json`. Schema: `Condition`. Specifies the base resource. _Example_ ``` { "resourceType": "Condition", "identifier": [ { "system": "CMS Blue Button 2.0", "value": "70000024", "type": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR-14", "display": "Mister" }] } } ], "clinicalStatus": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" }, { "system": "a", "code": "a" }] }, "verificationStatus": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" }, { "system": "a", "code": "a" }] }, "category": [ { "coding": [ {"system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "problem-list-item", "display": "FEM GENITAL SYMPTOMS NEC" }, {"system": "a", "code": "a", "display": "FEM GENITAL SYMPTOMS NEC" } ] }, { "coding": [ {"system": "c", "code": "problem-list-item", "display": "FEM GENITAL SYMPTOMS NEC" }, {"system": "b", "code": "b", "display": "FEM GENITAL SYMPTOMS NEC" } ] } ], "severity": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" }, { "system": "a", "code": "a" }] }, "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7005", "display": "FEM GENITAL SYMPTOMS NEC" }, { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7006", "display": "FEM GENITAL SYMPTOMS NEC" } ] }, "bodySite": [{ "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7005", "display": "FEM GENITAL SYMPTOMS NEC" }, { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7006", "display": "FEM GENITAL SYMPTOMS NEC" } ] }], "recordedDate": "2014-05-01T00:00:00-04:00", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "subject": { "reference": "Patient/001RO00000AzQZ9YAN" }, "stage": [{ "summary": { "coding": [{ "system": "http://snomed.info/system", "version": "1.1", "code": "123-06", "display": "stage-Display Number" }], "text": "stage-text-06" } }], "encounter": { "reference": "Encounter/0kGRO00000008Mb2AI" }, "onsetPeriod": {"start": "2020-02-24T03:38:15-06:00", "end": "2020-02-24T03:38:15-06:00"}, "abatementPeriod": {"start": "2020-02-24T03:38:15-06:00", "end": "2020-02-24T03:38:15-06:00"} } ``` #### Responses * **201** No match found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Condition/123`. Media type: `application/fhir+json`. Schema: `Condition (extended)`. Specifies the base resource. Includes all fields of `Condition`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "resourceType": "Condition", "identifier": [ { "system": "CMS Blue Button 2.0", "value": "70000024", "type": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR-14", "display": "Mister" }] } } ], "clinicalStatus": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" }, { "system": "a", "code": "a" }] }, "verificationStatus": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" }, { "system": "a", "code": "a" }] }, "category": [ { "coding": [ {"system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "problem-list-item", "display": "FEM GENITAL SYMPTOMS NEC" }, {"system": "a", "code": "a", "display": "FEM GENITAL SYMPTOMS NEC" } ] }, { "coding": [ {"system": "c", "code": "problem-list-item", "display": "FEM GENITAL SYMPTOMS NEC" }, {"system": "b", "code": "b", "display": "FEM GENITAL SYMPTOMS NEC" } ] } ], "severity": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" }, { "system": "a", "code": "a" }] }, "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7005", "display": "FEM GENITAL SYMPTOMS NEC" }, { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7006", "display": "FEM GENITAL SYMPTOMS NEC" } ] }, "bodySite": [{ "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7005", "display": "FEM GENITAL SYMPTOMS NEC" }, { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7006", "display": "FEM GENITAL SYMPTOMS NEC" } ] }], "recordedDate": "2014-05-01T00:00:00-04:00", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "subject": { "reference": "Patient/001RO00000AzQZ9YAN" }, "stage": [{ "summary": { "coding": [{ "system": "http://snomed.info/system", "version": "1.1", "code": "123-06", "display": "stage-Display Number" }], "text": "stage-text-06" } }], "encounter": { "reference": "Encounter/0kGRO00000008Mb2AI" }, "onsetPeriod": {"start": "2020-02-24T03:38:15-06:00", "end": "2020-02-24T03:38:15-06:00"}, "abatementPeriod": {"start": "2020-02-24T03:38:15-06:00", "end": "2020-02-24T03:38:15-06:00"}, "id": "123" } ``` * **400** Precondition failed error indicating insufficient client criteria. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### GET Get a condition record `GET /Condition/{id}` Retrieves the details for a specified record ID. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) * `Accept` (header, string) Allowed values: `application/fhir+json`. #### Responses * **200** Request is successful. Media type: `application/fhir+json`. Schema: `Condition`. Specifies the base resource. _Example_ ``` { "resourceType": "Condition", "id": "0j4RO0000000E8WYAU", "identifier": [ { "value": "70000024", "system": "CMS Blue Button 2.0", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR-14", "display": "Mister" } ], "text": "Condition identifier Bundle" } } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "resolved12" } ] }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "problem-list-item", "display": "problem-list-item" } ] } ], "severity": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "resolved12", "display": "resolved12" } ] }, "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7005", "display": "FEM GENITAL SYMPTOMS NEC" } ], "text": "Condition code Bundle" }, "bodySite": [ { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7005", "display": "FEM GENITAL SYMPTOMS NEC" } ], "text": "Condition code Bundle" } ], "subject": { "reference": "Patient/001RO00000AzQZ9YAN" }, "encounter": { "reference": "Encounter/0kGRO00000008Mb2AI" }, "onsetPeriod": { "start": "2020-02-24T09:38:15.000Z", "end": "2020-02-24T09:38:15.000Z" }, "abatementPeriod": { "start": "2020-02-24T09:38:15.000Z", "end": "2020-02-24T09:38:15.000Z" }, "recordedDate": "2014-05-01T04:00:00.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "stage": [ { "summary": { "coding": [ { "system": "http://snomed.info/system", "version": "1.1", "code": "123-06", "display": "stage-Display Number" } ], "text": "stage-text-06" } } ] } ``` * **404** Unknown resource. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### PUT Update a condition record `PUT /Condition/{id}` Creates either a record if no record exists for the specified ID or updates a record in the object. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) * `Accept` (header, string) Allowed values: `application/fhir+json`. #### Request body Media type: `application/fhir+json`. Schema: `Condition`. Specifies the base resource. _Example_ ``` { "resourceType": "Condition", "id": "123", "identifier": [ { "system": "CMS Blue Button 2.0", "value": "70000024", "type": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR-14", "display": "Mister" }] } } ], "clinicalStatus": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" }, { "system": "a", "code": "a" }] }, "verificationStatus": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" }, { "system": "a", "code": "a" }] }, "category": [ { "coding": [ {"system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "problem-list-item", "display": "FEM GENITAL SYMPTOMS NEC" }, {"system": "a", "code": "a", "display": "FEM GENITAL SYMPTOMS NEC" } ] }, { "coding": [ {"system": "c", "code": "problem-list-item", "display": "FEM GENITAL SYMPTOMS NEC" }, {"system": "b", "code": "b", "display": "FEM GENITAL SYMPTOMS NEC" } ] } ], "severity": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved12" }, { "system": "a", "code": "a" }] }, "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7005", "display": "FEM GENITAL SYMPTOMS NEC" }, { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7006", "display": "FEM GENITAL SYMPTOMS NEC" } ] }, "bodySite": [{ "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7005", "display": "FEM GENITAL SYMPTOMS NEC" }, { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "7006", "display": "FEM GENITAL SYMPTOMS NEC" } ] }], "recordedDate": "2014-05-01T00:00:00-04:00", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "subject": { "reference": "Patient/001RO00000AzQZ9YAN" }, "stage": [{ "summary": { "coding": [{ "system": "http://snomed.info/system", "version": "1.1", "code": "123-06", "display": "stage-Display Number" }], "text": "stage-text-06" } }], "encounter": { "reference": "Encounter/0kGRO00000008Mb2AI" }, "onsetPeriod": {"start": "2020-02-24T03:38:15-06:00", "end": "2020-02-24T03:38:15-06:00"}, "abatementPeriod": {"start": "2020-02-24T03:38:15-06:00", "end": "2020-02-24T03:38:15-06:00"} } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Condition/123`. Media type: `application/fhir+json`. Schema: `Condition (extended)`. Specifies the base resource. Includes all fields of `Condition`. * `id` (_string_, required) Specifies the Salesforce ID of the updated or created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example: same as PUT /Condition/{id} request._ * **201** Created the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Condition/123`. Media type: `application/fhir+json`. Schema: `Condition (extended)`. Specifies the base resource. Includes all fields of `Condition`. * `id` (_string_, required) Specifies the Salesforce ID of the updated or created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example: same as POST /Condition 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 /Condition 503 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### GET Get procedures for a patient `GET /Procedure` Retrieves a set of records by using filters. #### Parameters * `patient` (query, string) Search by a subject who is a patient. * `X-CORRELATION-ID` (header, string) #### Responses * **200** Request is successful. Media type: `application/fhir+json`. Schema: `ProcedureBundle (extended)`. Contains a collection of resources. * Rule: total only for search results or history. * Rule: entry.search only for a search request. * Rule: entry.request mandatory for batch, transaction, or history, otherwise prohibited. * Rule: entry.response mandatory for batch-response, transaction-response, or history, otherwise prohibited. * Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles). * Rule: A document must have an identifier with a system and a value. * Rule: A document must have a date. * Rule: A document must have a Composition as the first resource. * Rule: A message must have a MessageHeader as the first resource. Elements defined in Ancestors: id, meta, implicitRules, or language. Includes all fields of `ProcedureBundle`. * `entry` (_array of object_) Entry in the bundle - will have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl can't be a version specific reference. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type. Each item: Entry in the bundle - will have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl cannot be a version specific reference. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type. * `fullUrl` (_string_) The URI for the resource (Absolute URL server address or URI for UUID/OID). * `resource` (_object_, required) Specifies the base resource. * `followUp` (_array of object_) Describes the instructions for follow up. Each item: A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text. This is a common pattern in healthcare data. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `subject` (_object_, required) Specifies the person on whom the procedure was performed. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `code` (_object_) Specifies the code that identifies the procedure. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `identifier` (_array of object_) Specifies the external Identifiers for this procedure. Each item: A numeric or alphanumeric string that is related to 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 may be changed or retired due to human or system process and errors. * `use` (_string_) usual | official | temp | secondary (If known) Allowed values: `usual`, `official`, `temp`, `secondary`, `old`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `type` (_object_) Provides the description of Identifier. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `system` (_string_) Provides the namespace for Identifier value. * `value` (_string_) Specifies the ID value of Identifier. * `asserter` (_object_) Specifies the person who asserts this procedure. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `performer` (_array of object_) Specifies the people who performed the procedure. * `actor` (_object_, required) Specifies the reference to the practitioner. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `performedDateTime` (_string_) Specifies when the procedure was performed. 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)))?)?)?$. * `id` (_string_) Specifies the ID of the base resource. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `recorder` (_object_) Specifies the person who recorded the procedure. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `status` (_string_, required) Specifies the status of the procedure. Possible values are preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, or unknown. Allowed values: `preparation`, `in-progress`, `not-done`, `on-hold`, `stopped`, `completed`, `entered-in-error`, `unknown`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `reasonCode` (_array of object_) Specifies the coded reason for the procedure that was performed. Each item: A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text. This is a common pattern in healthcare data. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `search` (_object_) Provides the search-related information. * `mode` (_string_) Specifies the search mode and criteria. Possible values are match, include, or outcome. Allowed values: `match`, `include`, `outcome`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. _Example_ ``` { "resourceType": "Bundle", "id": "cab81941-bbcb-4004-b234-6df3c160fc7c", "meta": { "lastUpdated": "2023-08-08T10:35:46.509Z" }, "type": "searchset", "total": 15, "link": [ { "relation": "self", "url": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure" } ], "entry": [ { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G372AE", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G372AE", "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" } } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G2s2AE", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G2s2AE", "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" } } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G2x2AE", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G2x2AE", "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" } } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G2n2AE", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G2n2AE", "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" } } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G322AE", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G322AE", "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" } } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G2Y2AU", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G2Y2AU", "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" } } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G2T2AU", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G2T2AU", "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "performer": [ { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Procedure FUNCTION Bundle" }, "actor": { "reference": "Patient/001RO000004VTDCYA4" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ] } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ] } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ] } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G4y2AE", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G4y2AE", "identifier": [ { "use": "official", "value": "11000072", "system": "CMS Blue Button 2.0", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR11", "display": "MisterKWOK9" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR012", "display": "MisterKWOK9" } ], "text": "Identifier Bundle" } } ], "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "performer": [ { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Procedure FUNCTION Bundle" }, "actor": { "reference": "Patient/001RO000004VTDCYA4" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ] } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ] } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ] } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G532AE", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G532AE", "identifier": [ { "use": "official", "value": "11000073", "system": "CMS Blue Button 2.0", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR11", "display": "MisterKWOK9" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR012", "display": "MisterKWOK9" } ], "text": "Identifier Bundle" } } ], "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "performer": [ { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Procedure FUNCTION Bundle" }, "actor": { "reference": "Patient/001RO000004VTDCYA4" } }, { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Procedure FUNCTION Bundle" }, "actor": { "reference": "Patient/001RO000004VTDCYA4" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ] } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ] } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ] } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G5X2AU", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G5X2AU", "status": "completed", "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9-cm", "code": "6859", "display": "VAG HYSTERECTOMY NEC/NOS" } ], "text": "VAG HYSTERECTOMY NEC/NOS" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "encounter": { "reference": "Encounter/0kGRO0000000KM02AM" }, "performedDateTime": "2014-05-01T04:00:00.000Z" } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G5D2AU", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G5D2AU", "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" } } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G5I2AU", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G5I2AU", "identifier": [ { "use": "official", "value": "11000075", "system": "CMS Blue Button 2.0", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR11", "display": "MisterKWOK9" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR012", "display": "MisterKWOK9" } ], "text": "Identifier Bundle" } } ], "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "performer": [ { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Procedure FUNCTION Bundle" }, "actor": { "reference": "Patient/001RO000004VTDCYA4" } }, { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12344", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "actor": { "reference": "Patient/001RO000004VTDCYA4" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12345", "display": "Cough (finding)" } ] } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ] } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ] } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G5N2AU", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G5N2AU", "identifier": [ { "use": "official", "value": "11000076", "system": "CMS Blue Button 2.0", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR11", "display": "MisterKWOK9" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR012", "display": "MisterKWOK9" } ], "text": "Identifier Bundle" } } ], "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "performer": [ { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Procedure FUNCTION Bundle" }, "actor": { "reference": "Patient/001RO000004VTDCYA4" } }, { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12344", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "actor": { "reference": "Patient/001RO000004VTDCYA4" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12345", "display": "Cough (finding)" } ] } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ] } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ] } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G582AE", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G582AE", "identifier": [ { "use": "official", "value": "11000074", "system": "CMS Blue Button 2.0", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR11", "display": "MisterKWOK9" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR012", "display": "MisterKWOK9" } ], "text": "Identifier Bundle" } } ], "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO000004VIdsYAG" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ] } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ] } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ] } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/Procedure/0jQRO0000000G5S2AU", "search": { "mode": "match" }, "resource": { "resourceType": "Procedure", "id": "0jQRO0000000G5S2AU", "identifier": [ { "use": "official", "value": "11000077", "system": "CMS Blue Button 2.0", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR11", "display": "MisterKWOK9" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR012", "display": "MisterKWOK9" } ], "text": "Identifier Bundle" } } ], "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO000004VIdsYAG" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Practitioner/0cmRO00000002gtYAA" }, "asserter": { "reference": "Patient/001RO000004VIdsYAG" }, "performer": [ { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12347", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "actor": { "reference": "Patient/001RO000004VTDCYA4" } }, { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12348", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "actor": { "reference": "Practitioner/0cmRO00000002gtYAA" } }, { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12349", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "actor": { "reference": "Practitioner/0cmRO00000002gtYAA" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12345", "display": "Cough (finding)" } ] } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ] } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ] } ] } } ] } ``` * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### POST Create a procedure record `POST /Procedure` Creates a record in the AllergyIntolerance, HealthCondition, or PatientMedicalProcedure object as per the clinical summary API request. #### Parameters * `X-CORRELATION-ID` (header, string) * `Accept` (header, string) Allowed values: `application/fhir+json`. #### Request body Media type: `application/fhir+json`. Schema: `Procedure`. Specifies the base resource. _Example_ ``` { "resourceType": "Procedure", "identifier": [ { "use": "official", "system": "urn:custom:sourcesystem:fhirid", "value": "00-3", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR10a", "display": "MisterKWOK9" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR010b", "display": "MisterKWOK9" } ], "text": "Identifier Bundle" } } ], "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" }, { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" }, { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" }, { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "subject": { "reference": "Patient/001RO00000AzQZ9YAN" }, "performedDateTime": "2020-02-24T03:38:15-06:00", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "performer": [ { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" }, { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "actor": { "reference": "Practitioner/0cmRO00000004mrYAA" } }, { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" }, { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "actor": { "reference": "Organization/001RO00000586bqYAA" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" }, { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" }, { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ], "text": "Cough (finding)" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ], "text": "Cough (finding)" } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "Cough (finding)" } ], "text": "Cough (finding)" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ], "text": "Cough (finding)" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ], "text": "Cough (finding)" } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ], "text": "ROS 5 days - 2013-04-10" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ], "text": "ROS 5 days - 2013-04-10" } ] } ``` #### Responses * **201** No match found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Procedure/123`. Media type: `application/fhir+json`. Schema: `Procedure (extended)`. Specifies the base resource. Includes all fields of `Procedure`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "resourceType": "Procedure", "id": "0jQRO0000000G7Y2AU", "identifier": [ { "use": "official", "value": "00-3", "system": "urn:custom:sourcesystem:fhirid", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR010b", "display": "MisterKWOK9" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR10a", "display": "MisterKWOK9" } ], "text": "Identifier Bundle" } } ], "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason (Status Reason)" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure (procedure)" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy (Procedure)" }, "subject": { "reference": "Patient/001RO00000AzQZ9YAN" }, "performedDateTime": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "performer": [ { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Procedure FUNCTION Bundle" }, "actor": { "reference": "Practitioner/0cmRO00000004mrYAA" } }, { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Procedure FUNCTION Bundle" }, "actor": { "reference": "Patient/001RO00000586bqYAA" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ] } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "OCC12342" } ], "text": "OCC12342" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ] } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ] } ] } ``` * **400** Precondition failed error indicating insufficient client criteria. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### GET Get a procedure record `GET /Procedure/{id}` Retrieves the details for a specified record ID. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) * `Accept` (header, string) Allowed values: `application/fhir+json`. #### Responses * **200** Request is successful. Media type: `application/fhir+json`. Schema: `Procedure`. Specifies the base resource. _Example: same as POST /Procedure 201 response._ * **404** Unknown resource. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### PUT Update a procedure record `PUT /Procedure/{id}` Creates either a record if no record exists for the specified ID or updates a record in the object. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) * `Accept` (header, string) Allowed values: `application/fhir+json`. #### Request body Media type: `application/fhir+json`. Schema: `Procedure`. Specifies the base resource. _Example_ ``` { "resourceType": "Procedure", "id": "123", "identifier": [ { "use": "official", "system": "urn:custom:sourcesystem:fhirid", "value": "00-3", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR10a", "display": "MisterKWOK9" }, { "system": "http://terminology.hl7.org/CodeSystem/v2-0204", "code": "MR010b", "display": "MisterKWOK9" } ], "text": "Identifier Bundle" } } ], "status": "preparation", "statusReason": { "coding": [ { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" }, { "system": "http://snomed.info/sct", "code": "SR12342", "display": "Status Reason (Status Reason)" } ], "text": "Status Reason" }, "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" }, { "system": "http://snomed.info/sct", "code": "CAT12342", "display": "Diagnostic procedure (procedure)" } ], "text": "Diagnostic procedure" }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" }, { "system": "http://snomed.info/sct", "code": "CODE12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "subject": { "reference": "Patient/001RO00000AzQZ9YAN" }, "performedDateTime": "2020-02-24T03:38:15-06:00", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "performer": [ { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" }, { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "actor": { "reference": "Practitioner/0cmRO00000004mrYAA" } }, { "function": { "coding": [ { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" }, { "system": "http://snomed.info/sct", "code": "PFC12342", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "actor": { "reference": "Organization/001RO00000586bqYAA" } } ], "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" }, { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" }, { "system": "http://snomed.info/sct", "code": "RC12342", "display": "Testing" } ], "text": "Testing" } ], "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ], "text": "Cough (finding)" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "BSC12342", "display": "Cough (finding)" } ], "text": "Cough (finding)" } ], "outcome": { "coding": [ { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "OCC12342", "display": "Cough (finding)" } ], "text": "Cough (finding)" }, "complication": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ], "text": "Cough (finding)" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "COMPC12341", "display": "Cough (finding)" } ], "text": "Cough (finding)" } ], "followUp": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ], "text": "ROS 5 days - 2013-04-10" }, { "coding": [ { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" }, { "system": "http://snomed.info/sct", "code": "FLPC12342", "display": "Cough (finding)" } ], "text": "ROS 5 days - 2013-04-10" } ] } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Procedure/123`. Media type: `application/fhir+json`. Schema: `Procedure (extended)`. Specifies the base resource. Includes all fields of `Procedure`. * `id` (_string_, required) Specifies the Salesforce ID of the updated or created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example: same as PUT /Procedure/{id} request._ * **201** Created the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/Procedure/123`. Media type: `application/fhir+json`. Schema: `Procedure (extended)`. Specifies the base resource. Includes all fields of `Procedure`. * `id` (_string_, required) Specifies the Salesforce ID of the updated or created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example: same as POST /Procedure 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 /Condition 503 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### GET Get allergy intolerance records for a patient `GET /AllergyIntolerance` Retrieves a set of records by using filters. #### Parameters * `patient` (query, string) The patient who has an allergy or intolerance. * `X-CORRELATION-ID` (header, string) #### Responses * **200** Request is successful. Media type: `application/fhir+json`. Schema: `AllergyIntoleranceBundle (extended)`. Contains a collection of resources. * Rule: total only for search results or history. * Rule: entry.search only for a search request. * Rule: entry.request mandatory for batch, transaction, or history, otherwise prohibited. * Rule: entry.response mandatory for batch-response, transaction-response, or history, otherwise prohibited. * Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles). * Rule: A document must have an identifier with a system and a value. * Rule: A document must have a date. * Rule: A document must have a Composition as the first resource. * Rule: A message must have a MessageHeader as the first resource. Elements defined in Ancestors: id, meta, implicitRules, or language. Includes all fields of `AllergyIntoleranceBundle`. * `entry` (_array of object_) Entry in the bundle - will have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl can't be a version specific reference. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type. Each item: Entry in the bundle - will have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl cannot be a version specific reference. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type. * `fullUrl` (_string_) The URI for the resource (Absolute URL server address or URI for UUID/OID). * `resource` (_object_, required) Specifies the base resource. * `reaction` (_array of object_) Provides details about each adverse reaction event linked to the exposure to the identified substance. * `manifestation` (_array of object_, required) Specifies the clinical symptoms or signs observed or associated with the adverse reaction event. Each item: A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text. This is a common pattern in healthcare data. Minimum items: 1. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `modifierExtension` (_array of object_) Modifier Extensions Each item: Specifies the optional extensions element with a rule. Must have either extensions or value\[x\], but not both elements defined in the ancestors id or extension. * `url` (_string_, required) Identifies the meaning of the extension. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `value` (_string_) Specifies the value of extension. * `substance` (_object_) Specifies the potential substance or pharmaceutical product responsible for the event. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `exposureRoute` (_object_) Identifies the route by which the subject was exposed to the substance. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `onset` (_string_) Specifies the date or time of the onset of the reaction. 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)))?)?)?$. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `severity` (_string_) Specifies the severity of the issue while also potentially considering multiple different manifestations. Possible values are fatal, error, warning, or information. Allowed values: `mild`, `moderate`, `severe`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `description` (_string_) Describes textually the reaction as a whole, including details of the manifestation if required. * `clinicalStatus` (_object_) Specifies the clinical status of the allergy or intolerance. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `code` (_object_) Specifies the code that identifies the allergy or intolerance. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `identifier` (_array of object_) Specifies the identifiers related to the allergy or intolerance, defined by business processes or used as a reference. For example, when a direct URL reference to the resource, such as in Clinical Document Architecture (CDA) documents or in written or printed documentation, isn’t appropriate. Each item: A numeric or alphanumeric string that is related to 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 may be changed or retired due to human or system process and errors. * `use` (_string_) usual | official | temp | secondary (If known) Allowed values: `usual`, `official`, `temp`, `secondary`, `old`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `type` (_object_) Provides the description of Identifier. * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `system` (_string_) Provides the namespace for Identifier value. * `value` (_string_) Specifies the ID value of Identifier. * `asserter` (_object_) The source of the information about the allergy that is recorded. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `recordedDate` (_string_) Specifies the date on which the existence of the allergy or intolerance was first asserted or acknowledged. 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)))?)?)?$. * `id` (_string_) Specifies the ID of the base resource. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `criticality` (_string_) Specifies the estimate of the potential clinical harm or seriousness of the reaction to the identified substance. Allowed values: `low`, `high`, `unable-to-assess`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `encounter` (_object_) Specifies when the allergy or intolerance was asserted. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `patient` (_object_, required) The patient who has an allergy or intolerance. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `onsetDateTime` (_string_) Specifies when the allergy or intolerance was identified. 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)))?)?)?$. * `recorder` (_object_) The individual who recorded the record and takes responsibility for the content. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. * `id` (_string_) Specifies the internal ID. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. * `category` (_array of string_) Specifies the category of the identified substance. Each item: Indicates that the value is taken from a set of controlled strings defined elsewhere (see Using codes for further discussion). 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. Items: Allowed values: `food`, `medication`, `environment`, `biologic`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `type` (_string_) Identifies the underlying physiological mechanism for the reaction risk. Allowed values: `allergy`, `intolerance`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `verificationStatus` (_object_) Specifies the assertion about certainty associated with the propensity or potential risk of a reaction to the identified substance (including pharmaceutical product). * `coding` (_array of object_) Specifies a code defined by a terminology system. Each item: A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_string_) Sets the context for the code and defines the code’s meaning. * `version` (_string_) The version of the system to which the code belongs. * `code` (_string_) The system-defined code that’s represented by the code set. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. * `display` (_string_) Represents the meaning of the code as text. * `text` (_string_) Represents the meaning of the codeable concept as text. * `lastOccurence` (_string_) Represents the date or time of the last known occurrence of a reaction event. 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)))?)?)?$. * `search` (_object_) Provides the search-related information. * `mode` (_string_) Specifies the search mode and criteria. Possible values are match, include, or outcome. Allowed values: `match`, `include`, `outcome`. Pattern: ^\[^\\s\]+(\[\\s\]+\[^\\s\]+)\*$. _Example_ ``` { "resourceType": "Bundle", "id": "a89b06a4-a109-48a8-8072-2e9ae5261f0b", "meta": { "lastUpdated": "2023-08-08T10:07:45.313Z" }, "type": "searchset", "total": 13, "link": [ { "relation": "self", "url": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance" } ], "entry": [ { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E60YAE", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E60YAE", "identifier": [ { "use": "official", "value": "0001", "system": "http://acme.com/ids/patients/risks" } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z", "reaction": [ { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T09:38:15.000Z", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E57YAE", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E57YAE", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z", "reaction": [ { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T09:38:15.000Z", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E52YAE", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E52YAE", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z" } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E5CYAU", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E5CYAU", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z", "reaction": [ { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T09:38:15.000Z", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E5HYAU", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E5HYAU", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" } } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E5RYAU", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E5RYAU", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z", "reaction": [ { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T09:38:15.000Z", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } } ] } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E5MYAU", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E5MYAU", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" } } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E5WYAU", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E5WYAU", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z" } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E5gYAE", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E5gYAE", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z" } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E5qYAE", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E5qYAE", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z" } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E5lYAE", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E5lYAE", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z" } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E5vYAE", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E5vYAE", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z" } }, { "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-summary/fhir-r4/v1/AllergyIntolerance/0ibRO0000000E65YAE", "search": {}, "resource": { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E65YAE", "identifier": [ { "use": "official", "value": "0003", "system": "http://acme.com/ids/patients/risks" }, { "use": "official", "value": "0004", "system": "http://acme.com/ids/patients/risks" } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z", "reaction": [ { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T09:38:15.000Z", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } }, { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T09:38:15.000Z", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } } ] } } ] } ``` * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### POST Create an allergy intolerance record `POST /AllergyIntolerance` Creates a record in the AllergyIntolerance, HealthCondition, or PatientMedicalProcedure object as per the clinical summary API request. #### Parameters * `X-CORRELATION-ID` (header, string) * `Accept` (header, string) Allowed values: `application/fhir+json`. #### Request body Media type: `application/fhir+json`. Schema: `AllergyIntolerance`. Specifies the base resource. _Example_ ``` { "resourceType": "AllergyIntolerance", "identifier": [ { "use": "official", "system": "http://acme.com/ids/patients/risks", "value": "0003" }, { "use": "official", "system": "http://acme.com/ids/patients/risks", "value": "0004" } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" }, { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" }, { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "type": "allergy", "category": [ "food","medication" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" }, { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ] }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Practitioner/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z", "reaction": [ { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" }, { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" }, { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" }, { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T03:38:15-06:00", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" }, { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } }, { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" }, { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" }, { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" }, { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T03:38:15-06:00", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" }, { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } } ] } ``` #### Responses * **201** No match found. Resource created. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/AllergyIntolerance/123`. Media type: `application/fhir+json`. Schema: `AllergyIntolerance (extended)`. Specifies the base resource. Includes all fields of `AllergyIntolerance`. * `id` (_string_, required) Specifies the Salesforce ID of the created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example_ ``` { "resourceType": "AllergyIntolerance", "id": "0ibRO0000000E65YAE", "identifier": [ { "use": "official", "value": "0003", "system": "http://acme.com/ids/patients/risks" }, { "use": "official", "value": "0004", "system": "http://acme.com/ids/patients/risks" } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "Confirmed" } ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ], "text": "Cashew nuts" }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Patient/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z", "reaction": [ { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T09:38:15.000Z", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } }, { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T09:38:15.000Z", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } } ] } ``` * **400** Precondition failed error indicating insufficient client criteria. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### GET Get an allergy intolerance record `GET /AllergyIntolerance/{id}` Retrieves the details for a specified record ID. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) * `Accept` (header, string) Allowed values: `application/fhir+json`. #### Responses * **200** Request is successful. Media type: `application/fhir+json`. Schema: `AllergyIntolerance`. Specifies the base resource. _Example: same as POST /AllergyIntolerance 201 response._ * **404** Unknown resource. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ### PUT Update an allergy intolerance record `PUT /AllergyIntolerance/{id}` Creates either a record if no record exists for the specified ID or updates a record in the object. #### Parameters * `id` (path, id, required) * `X-CORRELATION-ID` (header, string) * `Accept` (header, string) Allowed values: `application/fhir+json`. #### Request body Media type: `application/fhir+json`. Schema: `AllergyIntolerance`. Specifies the base resource. _Example_ ``` { "resourceType": "AllergyIntolerance", "id": "123", "identifier": [ { "use": "official", "system": "http://acme.com/ids/patients/risks", "value": "0003" }, { "use": "official", "system": "http://acme.com/ids/patients/risks", "value": "0004" } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" }, { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" }, { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "type": "allergy", "category": [ "food","medication" ], "criticality": "high", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" }, { "system": "http://snomed.info/sct", "code": "227493005", "display": "Cashew nuts" } ] }, "patient": { "reference": "Patient/001RO00000AzQZ9YAN" }, "onsetDateTime": "2020-02-24T09:38:15.000Z", "recordedDate": "2020-02-24T09:38:15.000Z", "recorder": { "reference": "Practitioner/001RO00000AzQZ9YAN" }, "asserter": { "reference": "Patient/001RO00000AzQZ9YAN" }, "lastOccurrence": "2020-02-24T09:38:15.000Z", "reaction": [ { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" }, { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" }, { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" }, { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T03:38:15-06:00", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" }, { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } }, { "substance": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" }, { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "1160593", "display": "cashew nut allergenic extract Injectable Product" } ] }, "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" }, { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" }, { "system": "http://snomed.info/sct", "code": "39579001", "display": "Anaphylactic reaction" } ] } ], "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered", "onset": "2020-02-24T03:38:15-06:00", "severity": "severe", "exposureRoute": { "coding": [ { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" }, { "system": "http://snomed.info/sct", "code": "34206005", "display": "Subcutaneous route" } ] } } ] } ``` #### Responses * **200** Updated the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/AllergyIntolerance/123`. Media type: `application/fhir+json`. Schema: `AllergyIntolerance (extended)`. Specifies the base resource. Includes all fields of `AllergyIntolerance`. * `id` (_string_, required) Specifies the Salesforce ID of the updated or created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example: same as PUT /AllergyIntolerance/{id} request._ * **201** Created the resource. Headers: * `Location` (string, required) Specifies the URL where the resource can be fetched in subsequent requests. Example: `http://xxx/AllergyIntolerance/123`. Media type: `application/fhir+json`. Schema: `AllergyIntolerance (extended)`. Specifies the base resource. Includes all fields of `AllergyIntolerance`. * `id` (_string_, required) Specifies the Salesforce ID of the updated or created object. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. _Example: same as POST /AllergyIntolerance 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 /Condition 503 response._ * **503** Error connecting Salesforce. Media type: `application/fhir+json`. Schema: `OperationOutcome`. _Example: same as GET /Condition 503 response._ ## Schemas ### ConditionBundle Includes all fields of `Bundle`. * `entry` (_array of ConditionEntry_) ### OperationOutcome Information about the success or failure of an action. Elements defined in Ancestors id, meta, implicitRules, language, text, contained, extension, or modifierExtension. * `issue` (_array of object_, required) * `severity` (_code (string)_, required) Specifies the severity of the issue. Possible values are fatal, error, warning, or information. Allowed values: `fatal`, `error`, `warning`, `information`. * `code` (_code (string)_, required) Specifies the 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_) Specifies additional details about the error. Includes all fields of `CodeableConcept`. ### Condition Includes all fields of `Resource`. * `identifier` (_array of Identifier_) Specifies the external IDs for this condition. * `clinicalStatus` (_object_) Specifies the clinical status of the condition. Possible values are active, recurrence, inactive, remission, or resolved. Includes all fields of `CodeableConcept`. * `verificationStatus` (_object_) Specifies the verification status of the condition. Possible values are provisional, differential, confirmed, refuted, entered-in-error, or unconfirmed. Includes all fields of `CodeableConcept`. * `category` (_array of CodeableConcept_, required) Specifies the category of the condition. Possible values are problem-list-item or encounter-diagnosis. * `severity` (_object_) Specifies the subjective severity of the condition. Includes all fields of `CodeableConcept`. * `code` (_object_, required) Identifies the condition, such as a problem or diagnosis. Includes all fields of `CodeableConcept`. * `bodySite` (_array of CodeableConcept_) Specifies the anatomical location, if relevant. * `subject` (_object_, required) Specifies who has the condition. Includes all fields of `Reference`. * `encounter` (_object_) Specifies the encounter or episode when the condition first asserted. Includes all fields of `Reference`. * `onsetDateTime` (_dateTime (string)_) Specifies the estimated or actual date, datetime, or age of the condition. * `abatement​Date​Time` (_dateTime (string)_) Specifies when the condition is in resolution or remission. * `recordedDate` (_dateTime (string)_) Specifies the date record when the condition was believed to be accurate. * `recorder` (_object_) Specifies the person who recorded the condition. Includes all fields of `Reference`. * `asserter` (_object_) Specifies the person who asserts the condition. Includes all fields of `Reference`. * `stage` (_array of object_) Specifies the stage or grade, which is usually assessed formally. * Stage SHALL have summary. * `summary` (_object_) Specifies the disease-specific simple summary. Includes all fields of `CodeableConcept`. ### id 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. (This might be an integer, an un-prefixed OID, UUID, or any other identifier pattern that meets these constraints.) Type: `string`. Pattern: ^\[A-Za-z0-9\\-\\.\]{1,64}$. ### ProcedureBundle Includes all fields of `Bundle`. * `entry` (_array of ProcedureEntry_) ### Procedure Includes all fields of `Resource`. * `identifier` (_array of Identifier_) Specifies the external Identifiers for this procedure. * `status` (_code (string)_, required) Specifies the status of the procedure. Possible values are preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, or unknown. Allowed values: `preparation`, `in-progress`, `not-done`, `on-hold`, `stopped`, `completed`, `entered-in-error`, `unknown`. * `code` (_object_) Specifies the code that identifies the procedure. Includes all fields of `CodeableConcept`. * `subject` (_object_, required) Specifies the person on whom the procedure was performed. Includes all fields of `Reference`. * `recorder` (_object_) Specifies the person who recorded the procedure. Includes all fields of `Reference`. * `asserter` (_object_) Specifies the person who asserts this procedure. Includes all fields of `Reference`. * `performer` (_array of object_) Specifies the people who performed the procedure. * `actor` (_object_, required) Specifies the reference to the practitioner. Includes all fields of `Reference`. * `reasonCode` (_array of CodeableConcept_) Specifies the coded reason for the procedure that was performed. * `performedDateTime` (_dateTime (string)_) Specifies when the procedure was performed. * `followUp` (_array of CodeableConcept_) Describes the instructions for follow up. ### AllergyIntoleranceBundle Includes all fields of `Bundle`. * `entry` (_array of AllergyIntoleranceEntry_) ### AllergyIntolerance Includes all fields of `Resource`. * `identifier` (_array of Identifier_) Specifies the identifiers related to the allergy or intolerance, defined by business processes or used as a reference. For example, when a direct URL reference to the resource, such as in Clinical Document Architecture (CDA) documents or in written or printed documentation, isn’t appropriate. * `clinicalStatus` (_object_) Specifies the clinical status of the allergy or intolerance. Includes all fields of `CodeableConcept`. * `verificationStatus` (_object_) Specifies the assertion about certainty associated with the propensity or potential risk of a reaction to the identified substance (including pharmaceutical product). Includes all fields of `CodeableConcept`. * `type` (_code (string)_) Identifies the underlying physiological mechanism for the reaction risk. Allowed values: `allergy`, `intolerance`. * `category` (_array of code (string)_) Specifies the category of the identified substance. Items: Allowed values: `food`, `medication`, `environment`, `biologic`. * `criticality` (_code (string)_) Specifies the estimate of the potential clinical harm or seriousness of the reaction to the identified substance. Allowed values: `low`, `high`, `unable-to-assess`. * `code` (_object_) Specifies the code that identifies the allergy or intolerance. Includes all fields of `CodeableConcept`. * `patient` (_object_, required) The patient who has an allergy or intolerance. Includes all fields of `Reference`. * `encounter` (_object_) Specifies when the allergy or intolerance was asserted. Includes all fields of `Reference`. * `onsetDateTime` (_dateTime (string)_) Specifies when the allergy or intolerance was identified. * `recordedDate` (_dateTime (string)_) Specifies the date on which the existence of the allergy or intolerance was first asserted or acknowledged. * `recorder` (_object_) The individual who recorded the record and takes responsibility for the content. Includes all fields of `Reference`. * `asserter` (_object_) The source of the information about the allergy that is recorded. Includes all fields of `Reference`. * `lastOccurence` (_dateTime (string)_) Represents the date or time of the last known occurrence of a reaction event. * `reaction` (_array of object_) Provides details about each adverse reaction event linked to the exposure to the identified substance. Includes all fields of `BackboneElement`. * `substance` (_object_) Specifies the potential substance or pharmaceutical product responsible for the event. Includes all fields of `CodeableConcept`. * `manifestation` (_array of object_, required) Specifies the clinical symptoms or signs observed or associated with the adverse reaction event. Minimum items: 1. Includes all fields of `CodeableConcept`. * `description` (_string_) Describes textually the reaction as a whole, including details of the manifestation if required. * `onset` (_dateTime (string)_) Specifies the date or time of the onset of the reaction. * `severity` (_code (string)_) Specifies the severity of the issue while also potentially considering multiple different manifestations. Possible values are fatal, error, warning, or information. Allowed values: `mild`, `moderate`, `severe`. * `exposureRoute` (_object_) Identifies the route by which the subject was exposed to the substance. Includes all fields of `CodeableConcept`. ### Bundle Contains a collection of resources. * Rule: total only for search results or history. * Rule: entry.search only for a search request. * Rule: entry.request mandatory for batch, transaction, or history, otherwise prohibited. * Rule: entry.response mandatory for batch-response, transaction-response, or history, otherwise prohibited. * Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles). * Rule: A document must have an identifier with a system and a value. * Rule: A document must have a date. * Rule: A document must have a Composition as the first resource. * Rule: A message must have a MessageHeader as the first resource. Elements defined in Ancestors: id, meta, implicitRules, or language. * `type` (_object_, required) document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Allowed values: `document`, `message`, `transaction`, `transaction-response`, `batch`, `batch-response`, `history`, `searchset`, `collection`. Includes all fields of `code`. Allowed values: `document`, `message`, `transaction`, `transaction-response`, `batch`, `batch-response`, `history`, `searchset`, `collection`. * `id` (_object_, required) Specifies the ID of the clinical summary record. Includes all fields of `id`. * `total` (_object_) Specifies the number of matches with the search results. Includes all fields of `unsignedInt`. * `meta` (_object_, required) Holds the set of metadata (meta element) of the type Meta that each resource contains. Gives technical and workflow context to the resource. Though the metadata items are optional, some or all of the items are required in certain implementations or contexts. * `lastUpdated` (_object_) Specifies the date when the record was last updated. Includes all fields of `instant`. * `link` (_array of object_) Specifies the links related to the resource bundle. * `relation` (_string_, required) Specifies how this resource bundle link relates at the parent level. To know more about link relations, see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). * `url` (_object_, required) Provides the reference details for the link. Includes all fields of `uri`. * `entry` (_array of object_) Entry in the bundle - will have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl can't be a version specific reference. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type. Includes all fields of `Entry`. ### ConditionEntry Includes all fields of `Entry`. * `resource` (_Condition_, required) ### code Indicates that the value is taken from a set of controlled strings defined elsewhere (see Using codes for further discussion). 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 A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text. This is a common pattern in healthcare data. * `coding` (_array of Coding_) Specifies a code defined by a terminology system. * `text` (_string_) Represents the meaning of the codeable concept as text. ### Resource Specifies the base resource. * `id` (_id (string)_) Specifies the ID of the base resource. ### Identifier A numeric or alphanumeric string that is related to 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 may be changed or retired due to human or system process and errors. * `use` (_code (string)_) usual | official | temp | secondary (If known) Allowed values: `usual`, `official`, `temp`, `secondary`, `old`. * `type` (_object_) Provides the description of Identifier. Includes all fields of `CodeableConcept`. * `system` (_object_) Provides the namespace for Identifier value. Includes all fields of `uri`. * `value` (_string_) Specifies the ID value of Identifier. ### 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. Includes all fields of `Element`. * `reference` (_string_) Specifies a literal, relative, internal, or absolute URL reference. ### dateTime A date, date-time, or partial date (e.g. just year or year + month) as used in human communication. If hours and minutes are specified, a time zone is populated. Seconds must be provided due to schema type constraints but may be zero-filled and may 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)))?)?)?$. ### ProcedureEntry Includes all fields of `Entry`. * `resource` (_Procedure_, required) ### AllergyIntoleranceEntry Includes all fields of `Entry`. * `resource` (_AllergyIntolerance_, required) ### BackboneElement Includes all fields of `Element`. * `modifierExtension` (_array of Extension_) Modifier Extensions ### unsignedInt Specifies any non-negative integer (e.g. >= 0) Regex - \[0\]|(\[1-9\]\[0-9\]\*). Type: `integer`. Minimum: 0. ### instant An instant in time - known at least to the second and always includes a time zone. Note: This is intended for precisely observed times (typically system logs etc.), and not human-reported times - for them, use date and dateTime. Instant is a more constrained dateTime. Note: This type is for system times, not human times (see date and dateTime). 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)))))$. ### uri Specifies the Uniform Resource Identifier reference (see: [https://tools.ietf.org/html/rfc3986](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 may have an optional fragment identifier. Regex: \\S\* Type: `string`. ### Entry Entry in the bundle - will have a resource or information. * Rule: must be a resource unless there's a request or response. * Rule: fullUrl cannot be a version specific reference. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type. * `fullUrl` (_object_) The URI for the resource (Absolute URL server address or URI for UUID/OID). Includes all fields of `uri`. * `search` (_object_) Provides the search-related information. * `mode` (_code (string)_) Specifies the search mode and criteria. Possible values are match, include, or outcome. Allowed values: `match`, `include`, `outcome`. * `resource` (_object_) Specifies a resource in the bundle. Includes all fields of `Resource`. ### Coding A Coding is a representation of a defined concept using a symbol from a defined 'code system'. See [http://hl7.org/fhir/STU3/terminologies.html](http://hl7.org/fhir/STU3/terminologies.html) for more details. * `system` (_object_) Sets the context for the code and defines the code’s meaning. Includes all fields of `uri`. * `version` (_string_) The version of the system to which the code belongs. * `code` (_code (string)_) The system-defined code that’s represented by the code set. * `display` (_string_) Represents the meaning of the code as text. ### Element * `id` (_object_) Specifies the internal ID. Includes all fields of `id`. ### Extension Specifies the optional extensions element with a rule. Must have either extensions or value\[x\], but not both elements defined in the ancestors id or extension. Includes all fields of `Element`. * `url` (_object_, required) Identifies the meaning of the extension. Includes all fields of `uri`. * `value` (_string_) Specifies the value of extension.