Clinical Summary

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](\.[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 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 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 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 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](\.[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](\.[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 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 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 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 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."
                }
            }
        ]
    }