Home
API reference
Redox Data Models
Clinical Summary
PatientQueryResponse

Clinical Summary

This data model provides a snapshot of the patient's chart at a moment in time.

A clinical summary is useful if you need a patient's clinical information, whether historical or current. Our data model is based on Clinical Document Architecture (CDA) formatted documents, which focuses on different aspects of the patient's chart (e.g., allergies, immunizations, medications). We map any CDA document type to this data model. The most common is the Continuity of Care Document (CCD).

It may take up to 15 seconds to receive a response from the EHR system when querying for a clinical summary, depending on how long it takes the EHR system to generate a CCD.

This data model has event types that allow you to:

  • query for patient, visit, and document summaries;
  • receive patient, visit, and document summaries;
  • push patient or visit summaries; or
  • query for and receive a specific document.

PatientQueryResponse

Receive the most recent clinical summary based on the query parameters defined in PatientQuery. The response will contain the sections from Header through Vital Signs.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Clinical Summary

    • EventType
      required, string
      Reliable

      PatientQueryResponse

    • EventDateTime
      string, null
      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

      • ID
        string, null
        Reliable

        Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
      Required when sending data to Redox.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the endpoint that the request is directed to.

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        Reliable

        Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
        UUID

      • AttemptID
        string, null
        Reliable

        Identifies the request log attempt value, which is useful when retries are possible.
        UUID

    • FacilityCode
      string, null
      Possible

      Code for the facility related to the message.
      Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

    • Document
      object

      An object containing metadata about the document being pushed to the destination.

      • Author
        object
        • ID
          string, null
          Reliable

          ID of the Provider responsible for the document.
          This ID is often required for Inpatient Visits.

        • IDType
          string, null
          Reliable

          ID type of the ID for the Provider responsible for the document

        • FirstName
          string, null
          Possible

          First name of the Provider responsible for the document

        • LastName
          string, null
          Possible

          Last name of the Provider responsible for the document

        • Credentials
          Array of string

          List of credentials for the Provider responsible for the document.
          e.g. MD, PhD

        • Address
          object

          Provider's address

          • StreetAddress
            string, null
            Possible

            Street address

          • City
            string, null
            Possible

            City

          • State
            string, null
            Possible

            State

          • ZIP
            string, null
            Possible

            ZIP

          • County
            string, null
            Possible

            County

          • Country
            string, null
            Possible
            Value Set

            Country

        • EmailAddresses
          Array of string

          Provider's email address(es)

        • PhoneNumber
          object
          • Office
            string, null
            Possible

            Provider's office phone number.
            In E. 164 Format. (e.g. +16085551234)

        • Type
          string, null
          Reliable
          Value Set

          The type of Provider responsible for the document

        • Location
          object

          Provider's location

          • Type
            string, null
            Possible

            Type of location.
            Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

          • Facility
            string, null
            Possible

            Facility.
            Example: Community Hospital

          • FacilityIdentifiers
            Array of object

            List of IDs specific to this facility

            • ID
              string, null
              Possible

              An ID specific to this facility

            • IDType
              string, null
              Possible

              The source or system to which this ID pertains.
              Could be an OID or a human-readable name

          • Department
            string, null
            Possible

            Department

          • DepartmentIdentifiers
            Array of object

            List of IDs specific to this department

            • ID
              string, null
              Possible

              An ID specific to this department

            • IDType
              string, null
              Possible

              The source or system to which this ID pertains.
              Could be an OID or a human-readable name

          • Room
            string, null
            Possible

            Room.
            Example: 136

      • ID
        string, null
        Reliable

        Your application's ID for the document

      • SetID
        string, null
        Possible

        An ID for the document that is common across all document revisions.
        When SetID is provided, VersionNumber is required.

      • VersionNumber
        string, null
        Possible

        An integer version number for this revision of the document.
        When SetID is provided, VersionNumber is required. Used when superseding or modifying a prior version of the same document. For example, this document might be VersionNumber 2, and it has a RelatesTo[].VersionNumber 1, the prior version with the same RelatesTo[].SetID.

      • RelatesTo
        Array of object

        The identifiers for other documents related to this document, such as prior versions that this document replaces.

        • Code
          string, null
          Reliable

          A code for how the related document interacts with this document.
          FHIR Document Relationship Type or CDA RelatedDocument TypeCode: APND (appends), RPLC (replaces), or XFRM (transforms).

        • ID
          string, null
          Reliable

          The ID of the related document

        • SetID
          string, null
          Possible

          An ID for the document that is common across all document revisions.
          When SetID is provided, VersionNumber is required.

        • VersionNumber
          string, null
          Possible

          An integer version number for the related revision of the document.
          When SetID is provided, VersionNumber is required.

      • Locale
        string, null
        Reliable

        The language of the document.

      • Title
        string, null
        Reliable

        The title of the document.

      • DateTime
        string, null
        Reliable

        The creation/publishing date/time of the document.

      • Type
        string, null
        Reliable

        The type of document.
        This field is slated to be deprecated in favor of Header.Document.TypeCode.Name

      • TypeCode
        object
        • Code
          string, null
          Reliable

          A code describing the type of document.
          LOINC Document Type

        • CodeSystem
          string, null
          Reliable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Reliable

          Coding system to which the code belongs (LOINC preferred).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Reliable

          Name of the type of document.
          Summarization of Episode Note, Progress Note, etc.

      • Confidentiality
        object
        • Code
          string, null
          Reliable

          A code describing intended disclosure of information contained within the document.
          N (Normal), R (Restricted), V (Very Restricted)

        • CodeSystem
          string, null
          Reliable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Reliable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Reliable

          Name of intended disclosure of information contained within the document

      • Custodian
        object

        The organization or group responsible for the ongoing maintenance and access to the document

        • Identifiers
          Array of object

          List of IDs specific to this custodian organization

          • ID
            string, null
            Probable

            An ID specific to this custodian organization

          • IDType
            string, null
            Probable

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Name
          null, null
          Probable

          The name of the custodian organization

        • Type
          object
          • Code
            string, null
            Probable

            A code describing the kind of custodian organization

          • CodeSystem
            string, null
            Probable

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Probable

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Probable

            Name of the kind of custodian organization

          • AltCodes
            Array of object

            Alternate or translation codes for the kind of custodian organization

            • Code
              string, null
              Possible

              A code describing the kind of custodian organization

            • CodeSystem
              string, null
              Possible

              ID of the coding system to which the code belongs in OID format.
              Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

            • CodeSystemName
              string, null
              Possible

              Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
              Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

            • Name
              string, null
              Possible

              Name of the kind of custodian organization

        • Address
          object

          The address information for the custodian organization

          • StreetAddress
            string, null
            Probable

            Street address

          • City
            string, null
            Probable

            City

          • State
            string, null
            Probable

            State

          • ZIP
            string, null
            Probable

            ZIP

          • County
            string, null
            Possible

            County

          • Country
            string, null
            Possible
            Value Set

            Country

          • Use
            string, null
            Probable

            Use

        • Telecom
          Array of object

          Phone, fax, email, or other communication numbers for the custodian organization

          • Value
            null, null
            Probable

            The phone number or telecommunications address

          • Use
            null, null
            Probable

            The purpose of this telecommunications address (e.g. home, work, direct)

          • System
            null, null
            Probable

            The form of this address (e.g. phone, email, fax).
            Supported Values

    • Patient
      object
      • Identifiers
        Array of object

        An array of identifiers for the patient.

        • ID
          string, null
          Reliable

          The actual identifier for the patient.

        • IDType
          string, null
          Reliable

          An ID type associated with identifier (Medical Record Number, etc.)

        • Type
          string, null
          Reliable

          If present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.

      • Demographics
        object
        • FirstName
          string, null
          Reliable

          Patient's first name

        • MiddleName
          string, null
          Probable

          Patient's middle name

        • LastName
          string, null
          Reliable

          Patient's last name

        • DOB
          string, null
          Reliable

          Patient's date of birth.
          In YYYY-MM-DD format

        • SSN
          string, null
          Reliable

          Patient SSN

        • Sex
          string, null
          Reliable
          Value Set

          Patient gender

        • Address
          object
          • StreetAddress
            string, null
            Reliable
          • City
            string, null
            Reliable
          • State
            string, null
            Reliable
          • County
            string, null
            Reliable
          • Country
            string, null
            Reliable
          • ZIP
            string, null
            Reliable
          • Use
            string, null
            Possible
        • PhoneNumber
          object
          • Home
            string, null
            Reliable
          • Mobile
            string, null
            Reliable
        • EmailAddresses
          Array of object
          • Address
            string, null
            Reliable
        • Language
          string, null
          Possible

          Patient's primary spoken language.
          In ISO 639-1 alpha values (e.g. 'en'). Supported Values

        • Race
          string, null
          Reliable
          Value Set

          Patient's race - this is equivalent to the first RaceCodes[].Name

        • RaceCodes
          Array of object
          • Code
            string, null
            Probable

            A code describing the patient's race

          • CodeSystem
            string, null
            Probable

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Probable

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Probable

            Name of the patient's race

        • Ethnicity
          string, null
          Reliable

          One of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown

        • EthnicGroupCodes
          Array of object
          • Code
            string, null
            Probable

            A code describing the patient's ethnicity

          • CodeSystem
            string, null
            Probable

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Probable

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Probable

            Name of the patient's ethnicity

        • Religion
          string, null
          Reliable
          Value Set

          Patient's religious affiliation

        • MaritalStatus
          string, null
          Reliable
          Value Set
        • IsDeceased
          boolean, null
          Possible

          Indicates if the patient is deceased

        • DeathDateTime
          string, null
          Possible

          Date and Time the patient was proclaimed deceased.
          ISO 8601 Format

      • Organization
        object

        Organization that is the custodian of the patient record

        • Identifiers
          Array of object

          List of IDs specific to this organization

          • ID
            string, null
            Probable

            An ID specific to this organization

          • IDType
            string, null
            Probable

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Name
          null, null
          Probable

          The name of the organization

        • Type
          object
          • Code
            string, null
            Probable

            A code describing the kind of organization

          • CodeSystem
            string, null
            Probable

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Probable

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Probable

            Name of the kind of organization

          • AltCodes
            Array of object

            Alternate or translation codes for the kind of organization

            • Code
              string, null
              Possible

              A code describing the kind of organization

            • CodeSystem
              string, null
              Possible

              ID of the coding system to which the code belongs in OID format.
              Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

            • CodeSystemName
              string, null
              Possible

              Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
              Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

            • Name
              string, null
              Possible

              Name of the kind of organization

        • Address
          object

          The address information for the organization

          • StreetAddress
            string, null
            Probable

            Street address

          • City
            string, null
            Probable

            City

          • State
            string, null
            Probable

            State

          • ZIP
            string, null
            Probable

            ZIP

          • County
            string, null
            Possible

            County

          • Country
            string, null
            Possible
            Value Set

            Country

          • Use
            string, null
            Probable

            Use

        • Telecom
          Array of object

          Phone, fax, email, or other communication numbers for the organization

          • Value
            null, null
            Probable

            The phone number or telecommunications address

          • Use
            null, null
            Probable

            The purpose of this telecommunications address (e.g. home, work, direct)

          • System
            null, null
            Probable

            The form of this address (e.g. phone, email, fax).
            Supported Values

    • PCP
      object
      • ID
        string, null
        Possible

        ID of the Primary Care Provider for the Patient.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the Primary Care Provider for the Patient

      • FirstName
        string, null
        Possible

        First name of the Primary Care Provider for the Patient

      • LastName
        string, null
        Possible

        Last name of the Primary Care Provider for the Patient

      • Credentials
        Array of string

        List of credentials for the Primary Care Provider for the Patient.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Type
        string, null
        Possible
        Value Set

        The type of Primary Care Provider for the Patient

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

  • AdvanceDirectivesText
    string, null
    Probable

    Free text form of the advance directives summary

  • AdvanceDirectives
    Array of object
    • Type
      object
      • Code
        string, null
        Reliable

        A code describing the type of advance directive (such as resuscitation).
        SNOMED CT

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the type of advance directive (such as resuscitation)

      • AltCodes
        Array of object

        Alternate or translation codes for the type of advance directive (such as resuscitation)

        • Code
          string, null
          Possible

          A code describing the type of advance directive (such as resuscitation)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the type of advance directive (such as resuscitation)

    • Code
      string, null
      Reliable

      A code describing the value of the advance directive (such as 'do not resuscitate').
      SNOMED CT

    • CodeSystem
      string, null
      Reliable

      ID of the coding system to which the code belongs in OID format.
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • CodeSystemName
      string, null
      Reliable

      Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • Name
      string, null
      Reliable

      Name of the value of the advance directive (such as 'do not resuscitate')

    • AltCodes
      Array of object

      Alternate or translation codes for the value of the advance directive (such as 'do not resuscitate')

      • Code
        string, null
        Possible

        A code describing the value of the advance directive (such as 'do not resuscitate')

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the value of the advance directive (such as 'do not resuscitate')

    • StartDate
      string, null
      Reliable

      Effective start date of the advance directive.
      ISO 8601 Format

    • EndDate
      string, null
      Probable

      Effective end date of the advance directive.
      ISO 8601 Format

    • ExternalReference
      string, null
      Probable

      A link to a location where the document can be accessed.

    • VerifiedBy
      Array of object

      A collection of people who verified the advance directive with the patient

      • FirstName
        string, null
        Probable
      • LastName
        string, null
        Probable
      • Credentials
        string, null
        Probable
      • DateTime
        string, null
        Probable

        ISO 8601 Format

    • Custodians
      Array of object

      People legally responsible for the advance directive document.

      • FirstName
        string, null
        Probable
      • LastName
        string, null
        Probable
      • Credentials
        string, null
        Probable
      • Address
        object
        • StreetAddress
          string, null
          Probable
        • City
          string, null
          Probable
        • State
          string, null
          Probable
        • Country
          string, null
          Probable
        • ZIP
          string, null
          Probable
  • AllergyText
    string, null
    Reliable

    Free text form of the allergies summary.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • Allergies
    Array of object
    • Type
      object
      • Code
        string, null
        Reliable

        A code describing the type of allergy intolerance this is (food, drug, etc.).
        SNOMED CT from Allergy/Adverse Event Type Value Set

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the type of allergy intolerance this is (food, drug, etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)

        • Code
          string, null
          Possible

          A code describing the type of allergy intolerance this is (food, drug, etc.)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the type of allergy intolerance this is (food, drug, etc.)

    • Substance
      object
      • Code
        string, null
        Reliable

        A code describing the substance that the causes the allergy/intolerance.
        RxNorm, SNOMED CT, NDF-RT, UNII

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the substance that the causes the allergy/intolerance

      • AltCodes
        Array of object

        Alternate or translation codes for the substance that the causes the allergy/intolerance

        • Code
          string, null
          Possible

          A code describing the substance that the causes the allergy/intolerance

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the substance that the causes the allergy/intolerance

    • Reaction
      Array of object

      All the reactions caused by this particular substance.
      SNOMED CT

      • Code
        string, null
        Reliable

        A code describing the reaction caused by the allergy (dizziness, hives ,etc.).
        SNOMED CT

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the reaction caused by the allergy (dizziness, hives ,etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for the reaction caused by the allergy (dizziness, hives ,etc.)

        • Code
          string, null
          Possible

          A code describing the reaction caused by the allergy (dizziness, hives ,etc.)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the reaction caused by the allergy (dizziness, hives ,etc.)

      • Severity
        object
        • Code
          string, null
          Reliable

          A code describing a code for the severity of the reaction (moderate, severe, etc.).
          SNOMED CT

        • CodeSystem
          string, null
          Reliable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Reliable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Reliable

          Name of a code for the severity of the reaction (moderate, severe, etc.)

      • Text
        string, null
        Reliable

        Free text form of reactions to this substance, includes information that cannot be captured by coded value.

    • Severity
      object
      • Code
        string, null
        Possible

        A code describing a code for the severity of the reaction (moderate, severe, etc.).
        SNOMED CT. Note that when multiple reactions have different severities, the severity at the allergy[] level is generally the highest of all reaction severities. This field is no longer recommended for use, but is preserved for backwards compatibility.

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of a code for the severity of the reaction (moderate, severe, etc.).

    • Criticality
      object
      • Code
        string, null
        Possible

        A code describing a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
        SNOMED CT. Note this is a different concept than reaction severity.

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).

    • Status
      object
      • Code
        string, null
        Reliable

        A code describing the current status of the allergy (active, historic, etc.).
        SNOMED CT (Active, Inactive, Resolved)

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the current status of the allergy (active, historic, etc.)

    • IsNegativeIndicator
      boolean, null
      Possible

      Absent or false for a normal allergy/intolerance; indicates that the allergy/intolerance is explicitly unlikely when true

    • StartDate
      string, null
      Probable

      When the allergy was first noted.
      ISO 8601 Format

    • EndDate
      string, null
      Probable

      When the allergy was no longer a problem (if applicable).
      ISO 8601 Format

    • Comment
      string, null
      Possible

      Free text comment about the allergy.
      This field is slated to be deprecated in favor of Comments[].Text

    • Comments
      Array of object

      Free text comments about the allergy.

      • Text
        string, null
        Reliable

        The plain text comment.

  • CareTeamsText
    string, null
    Possible

    Free text summary of the patient's current and/or historical care teams.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • CareTeams
    Array of object
    • Name
      string, null

      Name of the care team

    • Status
      string, null

      Status of the care team

    • Types
      Array of object
      • Code
        string, null
        Probable

        A code describing type of care team.
        Care Team Category

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of type of care team

      • AltCodes
        Array of object

        Alternate or translation codes for type of care team

        • Code
          string, null
          Possible

          A code describing type of care team

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of type of care team

    • Organization
      object

      undefined

      • Identifiers
        Array of object

        List of IDs specific to this organization

        • ID
          string, null
          Probable

          An ID specific to this organization

        • IDType
          string, null
          Probable

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Name
        null, null
        Probable

        The name of the organization

      • Type
        object
        • Code
          string, null
          Probable

          A code describing the kind of organization

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the kind of organization

        • AltCodes
          Array of object

          Alternate or translation codes for the kind of organization

          • Code
            string, null
            Possible

            A code describing the kind of organization

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the kind of organization

      • Address
        object

        The address information for the organization

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

        • Use
          string, null
          Probable

          Use

      • Telecom
        Array of object

        Phone, fax, email, or other communication numbers for the organization

        • Value
          null, null
          Probable

          The phone number or telecommunications address

        • Use
          null, null
          Probable

          The purpose of this telecommunications address (e.g. home, work, direct)

        • System
          null, null
          Probable

          The form of this address (e.g. phone, email, fax).
          Supported Values

    • Encounter
      object
      • Identifiers
        Array of object

        List of IDs specific to this encounter

        • ID
          string, null
          Probable

          An ID specific to this encounter

        • IDType
          string, null
          Probable

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Status
        string, null
        Probable

        The status of the encounter

      • Type
        object
        • Code
          string, null
          Reliable

          A code describing the type of encounter (office visit, hospital, etc).
          CPT-4

        • CodeSystem
          string, null
          Reliable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Reliable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Reliable

          Name of the type of encounter (office visit, hospital, etc)

        • AltCodes
          Array of object

          Alternate or translation codes for the type of encounter (office visit, hospital, etc)

          • Code
            string, null
            Possible

            A code describing the type of encounter (office visit, hospital, etc)

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the type of encounter (office visit, hospital, etc)

      • DateTime
        string, null
        Reliable

        When the encounter took place, or alternatively when the encounter began if CareTeams[].Encounter.EndDateTime is present.
        ISO 8601 Format

      • EndDateTime
        string, null
        Possible

        When the encounter was completed, if available.
        ISO 8601 Format

    • Members
      Array of object

      Members of the care team

      • Identifiers
        Array of object

        List of IDs and ID Types that identify the concept

        • ID
          string, null
          Reliable

          ID for the concept

        • IDType
          string, null
          Reliable

          The type of ID

      • FirstName
        string, null

        First name of the care team member

      • MiddleName
        string, null

        Middle name of the care team member

      • LastName
        string, null

        Last name of the care team member

      • Credentials
        Array of string

        Credentials of the care team member

      • Address
        object

        Physical address

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

        • Use
          string, null
          Probable

          Use

      • Telecom
        Array of object

        Phone, fax, email, or other communication numbers for the care team member

        • Value
          null, null

          The phone number or telecommunications address

        • Use
          null, null

          The purpose of this telecommunications address (e.g. home, work, direct)

        • System
          null, null

          The form of this address (e.g. phone, email, fax).
          Supported Values

      • StartDateTime
        string, null

        When the care team member joined the care team.
        ISO 8601 Format

      • EndDateTime
        string, null

        When the care team member left the care team.
        ISO 8601 Format

      • Roles
        Array of object
        • Code
          string, null
          Probable

          A code describing the roles of the care team member

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the roles of the care team member

        • AltCodes
          Array of object

          Alternate or translation codes for the roles of the care team member

          • Code
            string, null
            Possible

            A code describing the roles of the care team member

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the roles of the care team member

  • EncountersText
    string, null
    Probable

    Free text form of the encounters summary.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • Encounters
    Array of object
    • Identifiers
      Array of object

      List of IDs specific to this encounter

      • ID
        string, null
        Probable

        An ID specific to this encounter

      • IDType
        string, null
        Probable

        The source or system to which this ID pertains.
        Could be an OID or a human-readable name

    • Status
      string, null
      Probable

      The status of the encounter

    • Type
      object
      • Code
        string, null
        Reliable

        A code describing the type of encounter (office visit, hospital, etc).
        CPT-4

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the type of encounter (office visit, hospital, etc)

      • AltCodes
        Array of object

        Alternate or translation codes for the type of encounter (office visit, hospital, etc)

        • Code
          string, null
          Possible

          A code describing the type of encounter (office visit, hospital, etc)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the type of encounter (office visit, hospital, etc)

    • DateTime
      string, null
      Reliable

      When the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present.
      ISO 8601 Format

    • EndDateTime
      string, null
      Possible

      When the encounter was completed, if available.
      ISO 8601 Format

    • Providers
      Array of object
      • NPI
        string, null
        Probable

        NPI of the Encounter Providers

      • ID
        string, null
        Probable

        ID of the Encounter Providers.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Probable

        ID type of the ID for the Encounter Providers

      • FirstName
        string, null
        Possible

        First name of the Encounter Providers

      • LastName
        string, null
        Possible

        Last name of the Encounter Providers

      • Credentials
        Array of string

        List of credentials for the Encounter Providers.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

      • Role
        object
        • Code
          string, null
          Probable

          A code describing the role of the provider (pcp, general physician, etc.)

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the role of the provider (pcp, general physician, etc.)

        • AltCodes
          Array of object

          Alternate or translation codes for the role of the provider (pcp, general physician, etc.)

          • Code
            string, null
            Possible

            A code describing the role of the provider (pcp, general physician, etc.)

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the role of the provider (pcp, general physician, etc.)

    • Locations
      Array of object
      • Identifiers
        Array of object

        List of IDs specific to this location

        • ID
          string, null
          Probable

          An ID specific to this location

        • IDType
          string, null
          Probable

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Telecom
        Array of object

        Phone, fax, email, or other communication numbers for the location

        • Value
          null, null
          Probable

          The phone number or telecommunications address

        • Use
          null, null
          Probable

          The purpose of this telecommunications address (e.g. home, work, direct)

        • System
          null, null
          Probable

          The form of this address (e.g. phone, email, fax).
          Supported Values

      • Address
        object
        • StreetAddress
          string, null
          Probable
        • City
          string, null
          Probable
        • State
          string, null
          Probable
        • Country
          string, null
          Probable
        • ZIP
          string, null
          Probable
      • Type
        object
        • Code
          string, null
          Probable

          A code describing the type of location where the patient was seen (clinic, urgent care, hospital).
          Healthcare Service Location

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the type of location where the patient was seen (clinic, urgent care, hospital)

        • AltCodes
          Array of object

          Alternate or translation codes for the type of location where the patient was seen (clinic, urgent care, hospital)

          • Code
            string, null
            Possible

            A code describing the type of location where the patient was seen (clinic, urgent care, hospital)

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the type of location where the patient was seen (clinic, urgent care, hospital)

      • Name
        string, null
        Probable

        The name of the location

    • Diagnosis
      Array of object

      An array of diagnoses

      • StartDate
        string, null
        Probable

        The onset date of the diagnosis.
        ISO 8601 Format

      • EndDate
        string, null
        Probable

        The resolution date of the diagnosis.
        ISO 8601 Format

      • Status
        object
        • Code
          string, null
          Possible

          A code describing the current state of the diagnosis (active, inactive, resolved).
          HITSPProblemStatus

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the current state of the diagnosis (active, inactive, resolved)

      • IsNegativeIndicator
        boolean, null
        Possible

        Absent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true

      • Code
        string, null
        Probable

        A code describing the diagnosis.
        ICD9, ICD10, HCPC, CPT, SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the diagnosis

      • AltCodes
        Array of object

        Alternate or translation codes for the diagnosis

        • Code
          string, null
          Possible

          A code describing the diagnosis

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the diagnosis

      • Comments
        Array of object

        Free text comments about the diagnosis.

        • Text
          string, null
          Reliable

          The plain text comment.

    • ReasonForVisit
      Array of object
      • Code
        string, null
        Probable

        A code describing the reason for the encounter (usually this is what the patient reports).
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the reason for the encounter (usually this is what the patient reports)

      • AltCodes
        Array of object

        Alternate or translation codes for the reason for the encounter (usually this is what the patient reports)

        • Code
          string, null
          Possible

          A code describing the reason for the encounter (usually this is what the patient reports)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the reason for the encounter (usually this is what the patient reports)

    • DischargeDisposition
      object
      • Code
        string, null
        Probable

        A code describing the discharge disposition of the visit.

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the discharge disposition of the visit.

      • AltCodes
        Array of object

        Alternate or translation codes for the discharge disposition of the visit.

        • Code
          string, null
          Possible

          A code describing the discharge disposition of the visit.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the discharge disposition of the visit.

  • FamilyHistoryText
    string, null
    Probable

    Free text form of the family history summary

  • FamilyHistory
    Array of object

    Each element of the FamilyHistory is one person in the patient's family.

    • Relation
      object
      • Code
        string, null
        Reliable

        A code describing the family member's relationship (father, mother, maternal grandfather, etc.).
        [HL7 Family History Related Subjects](http://www.hl7.org/documentcenter/private/standards/cda/r2/cda_r2_normativewebeditio n2010.zip)

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the family member's relationship (father, mother, maternal grandfather, etc.)

      • Demographics
        object
        • Sex
          string, null
          Probable
          Value Set

          Gender of the relative

        • DOB
          string, null
          Probable

          Date of Birth of the relative.
          In YYYY-MM-DD format

      • IsDeceased
        boolean, null
        Probable

        Whether or not the relative is deceased

    • Problems
      Array of object

      A list of the relative's relevant health problems

      • Code
        string, null
        Reliable

        A code describing a particular problem experienced by the relative.
        SNOMED CT

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of a particular problem experienced by the relative

      • AltCodes
        Array of object

        Alternate or translation codes for a particular problem experienced by the relative

        • Code
          string, null
          Possible

          A code describing a particular problem experienced by the relative

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of a particular problem experienced by the relative

      • Type
        object
        • Code
          string, null
          Reliable

          A code describing the general class of the problem. (disease, problem, etc.).
          Problem Type Value Set

        • CodeSystem
          string, null
          Reliable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Reliable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Reliable

          Name of the general class of the problem. (disease, problem, etc.)

      • DateTime
        string, null
        Probable

        The time when the problem started.
        ISO 8601 Format

      • AgeAtOnset
        string, null
        Probable

        The relative's age when the problem started

      • IsCauseOfDeath
        boolean, null
        Probable

        Flag indicating whether or not this problem was the cause of death for the relative.

  • FunctionalStatusText
    string, null
    Possible

    Free text form of the functional status summary

  • FunctionalStatus
    object
    • Observations
      Array of object

      Various types of observations about the patient's functional status.

      • Code
        string, null
        Probable

        A code describing a type of observation (functional status, activities of daily living, sensory status, etc.). .
        LOINC

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of a type of observation (functional status, activities of daily living, sensory status, etc.).

      • AltCodes
        Array of object

        Alternate or translation codes for a type of observation (functional status, activities of daily living, sensory status, etc.).

        • Code
          string, null
          Possible

          A code describing a type of observation (functional status, activities of daily living, sensory status, etc.).

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of a type of observation (functional status, activities of daily living, sensory status, etc.).

      • DateTime
        string, null
        Probable

        A specific date/time when the value was recorded.
        ISO 8601 Format

      • CodedValue
        object
        • Code
          string, null
          Possible

          A code describing the individual observation value, if a coded value.
          Only populated if the functional status is sent as a coded value. Observations[].CodedValue.Name will be duplicated in Observations[].Value

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the individual observation value, if a coded value.

        • AltCodes
          Array of object

          Alternate or translation codes for the individual observation value, if a coded value.

          • Code
            string, null
            Possible

            A code describing the individual observation value, if a coded value.

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the individual observation value, if a coded value.

      • Value
        string, null
        Probable

        The measurement recorded for the functional status observation.

      • Units
        string, null
        Probable

        The units of the measurement.
        UCUM Units of Measure

      • ReferenceRange
        object

        Reference range for the result.
        Numeric observation values will use the low and high properties. Non-numeric observation values will put the normal value in the text property.

        • Low
          number, null
          Possible

          Lower bound for a normal observation

        • High
          number, null
          Possible

          Upper bound for a normal observation

        • Text
          string, null
          Possible

          The normal value for non-numeric observations

      • Comments
        Array of object

        Free text comments about the observation.

        • Text
          string, null
          Reliable

          The plain text comment.

    • Supplies
      Array of object

      Non-medicinal supplies provided to the patient in the context of assessing the patient's physical abilities.

      • Code
        string, null
        Probable

        A code describing the supplied product.
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the supplied product

      • AltCodes
        Array of object

        Alternate or translation codes for the supplied product

        • Code
          string, null
          Possible

          A code describing the supplied product

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the supplied product

      • Status
        string, null
        Probable

        The state of the supplied product (intent, confirmed, etc).
        Plan of care status

      • DateTime
        string, null
        Probable

        The date/time of the activity. .
        ISO 8601 Format

  • GoalsText
    string, null
    Probable

    Free text form of the goals summary

  • Goals
    Array of object

    List of goals or targets for patient care.

    • Code
      string, null
      Probable

      A code describing the patient health goal.
      LOINC

    • CodeSystem
      string, null
      Probable

      ID of the coding system to which the code belongs in OID format.
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • CodeSystemName
      string, null
      Probable

      Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • Name
      string, null
      Probable

      Name of the patient health goal.

    • AltCodes
      Array of object

      Alternate or translation codes for the patient health goal.

      • Code
        string, null
        Possible

        A code describing the patient health goal.

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the patient health goal.

    • DateTime
      string, null
      Probable

      A specific date/time when the goal was recorded.
      ISO 8601 Format

    • CodedValue
      object
      • Code
        string, null
        Possible

        A code describing the individual goal or target value, if a coded value.
        Only populated if the goal is sent as a coded value. CodedValue.Name will be duplicated in Value

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the individual goal or target value, if a coded value.

      • AltCodes
        Array of object

        Alternate or translation codes for the individual goal or target value, if a coded value.

        • Code
          string, null
          Possible

          A code describing the individual goal or target value, if a coded value.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the individual goal or target value, if a coded value.

    • Value
      string, null
      Probable

      The individual goal or target value.

    • Units
      string, null
      Probable

      The units of the measurement.
      UCUM Units of Measure

    • StartDate
      string, null
      Probable

      Start date of goal.

    • EndDate
      string, null
      Probable

      Target completion date for goal.

    • Priority
      object
      • Code
        string, null
        Possible

        A code describing the level of importance associated with the goal.

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the level of importance associated with the goal.

    • AchievementStatus
      object
      • Code
        string, null
        Possible

        A code describing progression, or lack thereof, towards the goal.

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of progression, or lack thereof, towards the goal.

    • Milestones
      Array of object

      List of goals or targets for patient care.

      • Code
        string, null
        Probable

        A code describing the patient health goal.
        LOINC

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the patient health goal.

      • AltCodes
        Array of object

        Alternate or translation codes for the patient health goal.

        • Code
          string, null
          Possible

          A code describing the patient health goal.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the patient health goal.

      • DateTime
        string, null
        Probable

        A specific date/time when the goal was recorded.
        ISO 8601 Format

      • CodedValue
        object
        • Code
          string, null
          Possible

          A code describing the individual goal or target value, if a coded value.
          Only populated if the goal is sent as a coded value. CodedValue.Name will be duplicated in Value

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the individual goal or target value, if a coded value.

        • AltCodes
          Array of object

          Alternate or translation codes for the individual goal or target value, if a coded value.

          • Code
            string, null
            Possible

            A code describing the individual goal or target value, if a coded value.

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the individual goal or target value, if a coded value.

      • Value
        string, null
        Probable

        The individual goal or target value.

      • Units
        string, null
        Probable

        The units of the measurement.
        UCUM Units of Measure

      • StartDate
        string, null
        Probable

        Start date of goal.

      • EndDate
        string, null
        Probable

        Target completion date for goal.

      • Priority
        object
        • Code
          string, null
          Possible

          A code describing the level of importance associated with the goal.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the level of importance associated with the goal.

      • AchievementStatus
        object
        • Code
          string, null
          Possible

          A code describing progression, or lack thereof, towards the goal.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of progression, or lack thereof, towards the goal.

    • Comments
      Array of object

      Free text comments about the goal.

      • Text
        string, null
        Reliable

        The plain text comment.

  • HealthConcernsText
    string, null
    Reliable

    Free text form of the health concerns summary.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • HealthConcerns
    Array of object

    An array of all of patient relevant health concerns, current and historical.

    • ConcernType
      string, null
      Reliable

      The kind of FHIR resource this health concern would map to. For example, problems would map to Condition, and vital signs would map to Observation.
      Condition | Observation

    • Category
      object
      • Code
        string, null
        Reliable

        A code describing a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.
        Example codes: Condition Category Codes and Observation Category Codes

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.

      • AltCodes
        Array of object

        Alternate or translation codes for a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.

        • Code
          string, null
          Possible

          A code describing a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.

    • StartDate
      string, null
      Probable

      When the health concern was noticed.
      ISO 8601 Format

    • EndDate
      string, null
      Probable

      When the health concern stopped (if it is not current).
      ISO 8601 Format

    • Code
      string, null
      Reliable

      A code describing the actual health concern.
      LOINC or SNOMED CT

    • CodeSystem
      string, null
      Reliable

      ID of the coding system to which the code belongs in OID format.
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • CodeSystemName
      string, null
      Reliable

      Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • Name
      string, null
      Reliable

      Name of the actual health concern

    • AltCodes
      Array of object

      Alternate or translation codes for the actual health concern

      • Code
        string, null
        Possible

        A code describing the actual health concern

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the actual health concern

    • Value
      null, null
      Possible

      Observed value, required if the concern is an observation.

    • Units
      null, null
      Possible

      The units of measurement if the concern is an observation.
      UCUM Units of Measure

    • Interpretation
      string, null
      Possible

      A flag indicating whether or not the observed value is normal, high, or low.
      Supported Values

    • TargetSite
      object
      • Code
        string, null
        Possible

        A code describing the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

      • AltCodes
        Array of object

        Alternate or translation codes for the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

        • Code
          string, null
          Possible

          A code describing the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

    • Status
      string, null
      Probable

      The current state of the health concern (active, inactive)

    • Comments
      Array of object

      Free text comments about the health concern.

      • Text
        string, null
        Reliable

        The plain text comment.

  • ImmunizationText
    string, null
    Probable

    Free text form of the immunization summary

  • Immunizations
    Array of object

    Array of immunizations for patient.

    • DateTime
      string, null
      Reliable

      When the immunization was given.
      ISO 8601 Format

    • Route
      object
      • Code
        string, null
        Probable

        A code describing the way in which the immunization was delivered (intramuscular, oral, etc.).
        [Medication Route FDA Value Set](http://www.fda.gov/ForIndustry/DataStandards/StructuredProductLabeling /ucm162034.htm)

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the way in which the immunization was delivered (intramuscular, oral, etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for the way in which the immunization was delivered (intramuscular, oral, etc.)

        • Code
          string, null
          Possible

          A code describing the way in which the immunization was delivered (intramuscular, oral, etc.)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the way in which the immunization was delivered (intramuscular, oral, etc.)

    • Status
      string, null
      Possible

      The status of the immunization.

    • Product
      object
      • Manufacturer
        string, null
        Probable

        Name of organization that manufacture the immunization.
        Free text

      • Code
        string, null
        Reliable

        A code describing the vaccination that was given.
        CVX code system

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the vaccination that was given

      • AltCodes
        Array of object

        Alternate or translation codes for the vaccination that was given

        • Code
          string, null
          Possible

          A code describing the vaccination that was given

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the vaccination that was given

      • LotNumber
        string, null
        Probable

        The lot number of the vaccine

    • Dose
      object
      • Quantity
        string, null
        Probable

        The size of the dose

      • Units
        string, null
        Probable

        The units of the dose.
        UCUM Units of Measure

    • ReasonNotGiven
      string, null
      Possible

      If this immunization was not administered, this will contain the reason not given. If null, then the immunization was administered normally.
      FHIR Immunization Status Reason Codes

    • AdministrationHistory
      Array of object

      A list of recent administrations of this immunization

      • StartDate
        string, null
        Possible

        When the immunization administration was started.
        ISO 8601 Format

      • EndDate
        string, null
        Possible

        When the immunization administration ended.
        ISO 8601 Format

  • InsurancesText
    string, null
    Possible

    Free text form of the patient's insurances.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • Insurances
    Array of object

    List of insurance coverages for the patient

    • Plan
      object
      • ID
        string, null
        Probable

        Identifier of insurance plan

      • IDType
        string, null
        Probable

        ID type of insurance plan

      • Name
        string, null
        Probable

        Name of insurance plan

      • Type
        string, null
        Possible

        Type of insurance plan

    • MemberNumber
      string, null
      Possible

      Patient member number

    • Company
      object
      • ID
        string, null
        Possible

        ID of insurance company (payor).
        Typically not available in ClinicalSummary.

      • IDType
        string, null
        Possible

        ID type of insurance company (payor).
        Typically not available in ClinicalSummary.

      • Name
        string, null
        Probable

        Name of insurance company (payor)

      • Address
        object

        Insurance company's address

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

        • Use
          string, null
          Probable

          Use

      • PhoneNumber
        string, null
        Probable

        Insurance companys phone number.
        In E. 164 Format (i.e. +16085551234)

    • GroupNumber
      string, null
      Probable

      Insurance policy group number

    • GroupName
      string, null
      Possible

      Insurance policy group name.
      Typically not available in ClinicalSummary.

    • EffectiveDate
      string, null
      Probable

      Effect date of this insurance policy.
      In YYYY-MM-DD format

    • ExpirationDate
      string, null
      Probable

      Expiration date of this insurance policy.
      In YYYY-MM-DD format

    • PolicyNumber
      string, null
      Probable

      Insurance policy number

    • Priority
      string, null
      Possible
      Value Set

      The insurance priority sequence.
      If the insurance works in conjunction with other insurance plans, this field contains priority sequence.

    • AgreementType
      string, null
      Possible

      Type of insurance agreement.
      Typically not available in ClinicalSummary.

    • CoverageType
      string, null
      Probable
      Value Set

      Type of insurance agreement.
      Indicates who will be receiving the bill for the service.

    • Insured
      object

      Individual who has the agreement with the insurance company for the related policy

      • Identifiers
        Array of object

        List of IDs and ID types that identify the insured

        • ID
          string, null
          Possible

          ID for the insured

        • IDType
          string, null
          Possible

          Type of ID.
          E.g. MRN, EPI

      • LastName
        string, null
        Possible

        Last name of the insured

      • MiddleName
        string, null
        Possible

        Middle name of the insured

      • FirstName
        string, null
        Possible

        First name of the insured

      • SSN
        string, null
        Possible

        Insured's social security number

      • Relationship
        string, null
        Possible
        Value Set

        Relationship of the insured to the patient

      • DOB
        string, null
        Possible

        Date of birth of the insured.
        In YYYY-MM-DD format

      • Sex
        string, null
        Possible
        Value Set

        Sex of the insured

      • Address
        object

        Address of the insured

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

        • Use
          string, null
          Probable

          Use

  • MedicalEquipmentText
    string, null
    Probable

    Free text form of the medical equipment summary

  • MedicalEquipment
    Array of object

    A list of medical equipment that the patient uses (cane, pacemakers, etc.)

    • Status
      string, null
      Reliable

      The current status of the equipment (active, completed, etc.)

    • StartDate
      string, null
      Probable

      When the equipment was first put into use.
      ISO 8601 Format

    • Quantity
      string, null
      Probable

      The number of products used

    • Comments
      Array of object

      Free text comments about the device or equipment.

      • Text
        string, null
        Reliable

        The plain text comment.

    • Product
      object
      • Code
        string, null
        Probable

        A code describing the actual product.
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the actual product.

      • AltCodes
        Array of object

        Alternate or translation codes for the actual product.

        • Code
          string, null
          Possible

          A code describing the actual product.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the actual product.

      • Identifiers
        Array of object

        Identifiers for the equipement or device.
        Unique Device Identifier (UDI) components are present in other fields.

        • ID
          string, null
          Probable

          ID for the equipment or device

        • IDType
          string, null
          Probable

          Type of ID

      • DeviceID
        string, null
        Probable

        The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

      • Issuer
        string, null
        Probable

        Organization that is charged with issuing UDIs for devices.
        GS1, HIBCC, ICCBBA, ICCBA

      • SerialNumber
        string, null
        Probable

        The device serial number

      • DistinctID
        string, null
        Probable

        The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.

      • ManufacturerName
        string, null
        Probable

        The name of the manufacturer

      • LotNumber
        string, null
        Probable

        Lot or batch number assigned by the manufacturer

      • ManufactureDate
        string, null
        Probable

        The date the product was manufactured.
        In ISO 8601 format

      • ExpirationDate
        string, null
        Probable

        The date and time beyond which this device is no longer valid or should not be used (if applicable).
        In ISO 8601 format

      • BrandName
        string, null
        Probable

        The name of the device as given by the manufacturer

      • ModelNumber
        string, null
        Probable

        The manufacturer's model number for the device

      • CatalogNumber
        string, null
        Probable

        The part number or catalog number of the device

      • Status
        object
        • Code
          string, null
          Probable

          A code describing the status of the patient's implantable medical device.
          Implantable Device Status Value Set

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the status of the patient's implantable medical device

      • SafetyObservations
        Array of object
        • Code
          string, null
          Probable

          A code describing additional safety characteristics about a medical device. for example devices containing latex.

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of additional safety characteristics about a medical device. for example devices containing latex.

        • AltCodes
          Array of object

          Alternate or translation codes for additional safety characteristics about a medical device. for example devices containing latex.

          • Code
            string, null
            Possible

            A code describing additional safety characteristics about a medical device. for example devices containing latex.

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of additional safety characteristics about a medical device. for example devices containing latex.

    • Procedure
      object
      • Code
        string, null
        Probable

        A code describing the procedure performed during which the device was implanted

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the procedure performed during which the device was implanted

      • AltCodes
        Array of object

        Alternate or translation codes for the procedure performed during which the device was implanted

        • Code
          string, null
          Possible

          A code describing the procedure performed during which the device was implanted

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the procedure performed during which the device was implanted

      • TargetSite
        object
        • Code
          string, null
          Probable

          A code describing the location on the body where the device was implanted

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the location on the body where the device was implanted

        • AltCodes
          Array of object

          Alternate or translation codes for the location on the body where the device was implanted

          • Code
            string, null
            Possible

            A code describing the location on the body where the device was implanted

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the location on the body where the device was implanted

  • MedicationsText
    string, null
    Reliable

    Free text form of the medications summary.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • Medications
    Array of object
    • Prescription
      boolean, null
      Reliable

      Whether the medication is a prescription.
      For a prescription: true. For a patient reported med, or a med administered by a provider: false

    • FreeTextSig
      string, null
      Possible

      Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication

    • Dose
      object
      • Quantity
        string, null
        Probable

        The size of the dose for pills, capsules, etc.

      • Units
        string, null
        Probable

        The units of the dose.
        UCUM Units of Measure

    • Rate
      object
      • Quantity
        string, null
        Probable

        If the medication is in liquid form, the rate at which it is administered

      • Units
        string, null
        Probable

        Units for the rate.
        UCUM Units of Measure

    • Route
      object
      • Code
        string, null
        Probable

        A code describing the method by which the medication is delivered.
        Medication Route FDA Value Set

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the method by which the medication is delivered

      • AltCodes
        Array of object

        Alternate or translation codes for the method by which the medication is delivered

        • Code
          string, null
          Possible

          A code describing the method by which the medication is delivered

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the method by which the medication is delivered

    • Status
      string, null
      Possible

      The status of the medication.

    • StartDate
      string, null
      Reliable

      When the medication was started.
      ISO 8601 Format

    • EndDate
      string, null
      Probable

      When the medication ended.
      ISO 8601 Format

    • Frequency
      object
      • Period
        string, null
        Probable

        How often the patient should be taking the medication

      • PeriodMax
        string, null
        Possible

        How often the patient should be taking the medication at a maximum

      • Unit
        string, null
        Probable

        Units for how often the patient should be taking the medication.
        UCUM Units of Measure

      • EventCode
        string, null
        Possible

        Real world event that describes the frequency.
        HL7 Timing Event

      • InstitutionSpecified
        boolean, null
        Possible

        Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".)

    • NumberOfRefillsRemaining
      number, null
      Possible

      The number of authorized refills remaining on the prescription

    • TotalRefills
      number, null
      Probable

      The total number of refills prescribed

    • LastRefillDate
      string, null
      Probable

      The date the refill was last filled.
      ISO 8601 Format

    • IsPRN
      boolean, null
      Probable

      Whether the medication is to be taken on an as-needed basis

    • Product
      object
      • Code
        string, null
        Reliable

        A code describing the actual medication given .
        RxNorm

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the actual medication given

      • AltCodes
        Array of object

        Alternate or translation codes for the actual medication given

        • Code
          string, null
          Possible

          A code describing the actual medication given

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the actual medication given

    • Indications
      Array of object
      • Code
        string, null
        Possible

        A code describing the reason the medication was given.
        SNOMED CT

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the reason the medication was given

      • AltCodes
        Array of object

        Alternate or translation codes for the reason the medication was given

        • Code
          string, null
          Possible

          A code describing the reason the medication was given

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the reason the medication was given

    • SupplyOrder
      object
      • StartDate
        string, null
        Reliable

        When the medication supply order was starts.
        ISO 8601 Format

      • EndDate
        string, null
        Probable

        When the medication supply order ends.
        ISO 8601 Format

      • Quantity
        string, null
        Probable

        The quantity of the medication supply order

      • Units
        string, null
        Probable

        The units of the supply order.
        UCUM Units of Measure

      • NumberOfRefillsRemaining
        number, null
        Possible

        The number of authorized refills remaining on the medication supply order

    • AdministrationHistory
      Array of object

      A list of recent administrations of this medication

      • StartDate
        string, null
        Possible

        When the medication administration was started.
        ISO 8601 Format

      • EndDate
        string, null
        Possible

        When the medication administration ended.
        ISO 8601 Format

  • PlanOfCareText
    string, null
    Probable

    Free text form of the plan of care summary.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • PlanOfCare
    object
    • Orders
      Array of object

      Future lab tests or other diagnostic procedures.

      • Code
        string, null
        Probable

        A code describing the test to be performed .
        LOINC

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the test to be performed

      • AltCodes
        Array of object

        Alternate or translation codes for the test to be performed

        • Code
          string, null
          Possible

          A code describing the test to be performed

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the test to be performed

      • Status
        string, null
        Probable

        The state of the plan (intent, confirmed, etc).
        Plan of care status

      • DateTime
        string, null
        Probable

        ISO 8601 Format

    • Procedures
      Array of object

      Future procedures.

      • Code
        string, null
        Probable

        A code describing the planned procedure, such as an appendectomy or hip replacement .
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the planned procedure, such as an appendectomy or hip replacement

      • AltCodes
        Array of object

        Alternate or translation codes for the planned procedure, such as an appendectomy or hip replacement

        • Code
          string, null
          Possible

          A code describing the planned procedure, such as an appendectomy or hip replacement

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the planned procedure, such as an appendectomy or hip replacement

      • Status
        string, null
        Probable

        The state of the plan (intent, confirmed, etc).
        Plan of care status

      • DateTime
        string, null
        Probable

        ISO 8601 Format

    • Encounters
      Array of object

      Appointments and other upcoming encounters

      • Code
        string, null
        Probable

        A code describing the planned encounter type .
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the planned encounter type

      • AltCodes
        Array of object

        Alternate or translation codes for the planned encounter type

        • Code
          string, null
          Possible

          A code describing the planned encounter type

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the planned encounter type

      • Identifiers
        Array of object

        List of IDs and ID types that identifies the encounter

        • ID
          string, null
          Possible

          ID for the encounter

        • IDType
          string, null
          Possible

          Type of ID

      • Status
        string, null
        Probable

        The state of the plan (intent, confirmed, etc).
        Plan of care status

      • DateTime
        string, null
        Probable

        ISO 8601 Format

    • MedicationAdministration
      Array of object

      Planned medication

      • Status
        string, null
        Probable

        The state of the plan (intent, confirmed, etc).
        Plan of care status

      • Dose
        object
        • Quantity
          string, null
          Probable

          The size of the dose for pills, capsules, etc.

        • Units
          string, null
          Probable

          The units of the dose.
          UCUM Units of Measure

      • Rate
        object
        • Quantity
          string, null
          Probable

          If the medication is not in does form, this is the rate at which is administered

        • Units
          string, null
          Probable

          Units for the rate.
          UCUM Units of Measure

      • Route
        object
        • Code
          string, null
          Probable

          A code describing the method by which the medication is to be delivered.
          Medication Route FDA Value Set

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the method by which the medication is to be delivered

        • AltCodes
          Array of object

          Alternate or translation codes for the method by which the medication is to be delivered

          • Code
            string, null
            Possible

            A code describing the method by which the medication is to be delivered

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the method by which the medication is to be delivered

      • StartDate
        string, null
        Probable

        When the medication was started

      • EndDate
        string, null
        Probable

        When the medication ended

      • Frequency
        object
        • Period
          string, null
          Probable

          How often the patient should be taking the medication.
          UCUM Units of measure

        • Unit
          string, null
          Probable

          Units for how often the patient should be taking the medication

      • Product
        object
        • Code
          string, null
          Probable

          A code describing the planned medication .
          RxNorm

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the planned medication

        • AltCodes
          Array of object

          Alternate or translation codes for the planned medication

          • Code
            string, null
            Possible

            A code describing the planned medication

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the planned medication

    • Supplies
      Array of object

      Future supplies that a patient may be given, including implants.

      • Code
        string, null
        Probable

        A code describing the planned product.
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the planned product

      • AltCodes
        Array of object

        Alternate or translation codes for the planned product

        • Code
          string, null
          Possible

          A code describing the planned product

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the planned product

      • Status
        string, null
        Probable

        The state of the plan (intent, confirmed, etc).
        Plan of care status

      • DateTime
        string, null
        Probable

        The scheduled time of the activity. .
        ISO 8601 Format

    • Services
      Array of object

      Planned activities that are service-oriented in nature, such as a dressing change, or feeding a patient.

      • Code
        string, null
        Probable

        A code describing the planned activity.
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the planned activity.

      • AltCodes
        Array of object

        Alternate or translation codes for the planned activity.

        • Code
          string, null
          Possible

          A code describing the planned activity.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the planned activity.

      • Status
        string, null
        Probable

        The state of the plan (intent, confirmed, etc).
        Plan of care status

      • DateTime
        string, null
        Probable

        The scheduled time of the activity. .
        ISO 8601 Format

  • ProblemsText
    string, null
    Reliable

    Free text form of the problems summary.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • Problems
    Array of object

    An array of all of patient relevant problems, both current and historical.

    • StartDate
      string, null
      Probable

      When the problem was noticed.
      ISO 8601 Format

    • EndDate
      string, null
      Probable

      When the problem stopped (if it is not current).
      ISO 8601 Format

    • Code
      string, null
      Reliable

      A code describing the actual problem .
      SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009)

    • CodeSystem
      string, null
      Reliable

      ID of the coding system to which the code belongs in OID format.
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • CodeSystemName
      string, null
      Reliable

      Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • Name
      string, null
      Reliable

      Name of the actual problem

    • AltCodes
      Array of object

      Alternate or translation codes for the actual problem

      • Code
        string, null
        Possible

        A code describing the actual problem

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the actual problem

    • Category
      object
      • Code
        string, null
        Reliable

        A code describing the type of problem this is (complaint, diagnosis, symptom, etc.)

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the type of problem this is (complaint, diagnosis, symptom, etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for the type of problem this is (complaint, diagnosis, symptom, etc.)

        • Code
          string, null
          Possible

          A code describing the type of problem this is (complaint, diagnosis, symptom, etc.)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the type of problem this is (complaint, diagnosis, symptom, etc.)

    • Status
      object
      • Code
        string, null
        Probable

        A code describing the current state of the problem (active, inactive, resolved).
        HITSPProblemStatus

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the current state of the problem (active, inactive, resolved)

    • Comment
      string, null
      Possible

      Free text comment about the problem.
      This field is slated to be deprecated in favor of Comments[].Text

    • Comments
      Array of object

      Free text comments about the problem.

      • Text
        string, null
        Reliable

        The plain text comment.

    • HealthStatus
      object
      • Code
        string, null
        Possible

        A code describing the effect of the problem on the patient (chronically ill, in remission, etc.).
        SNOMED-CT

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the effect of the problem on the patient (chronically ill, in remission, etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for the effect of the problem on the patient (chronically ill, in remission, etc.)

        • Code
          string, null
          Possible

          A code describing the effect of the problem on the patient (chronically ill, in remission, etc.)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the effect of the problem on the patient (chronically ill, in remission, etc.)

  • ProceduresText
    string, null
    Probable

    Free text form of the procedures summary

  • Procedures
    object

    A general grouper for all things that CDA considers procedures, grouped into three kinds.

    -Observations - procedures which result in new information about a patient.

    -Procedures - procedures whose immediate and primary outcome is the alteration of the physical condition of the patient.

    -Services (Sometimes called Acts) - procedures which cannot be classified as an observation or a procedure, such as a dressing change, feeding, or teaching.

    • Observations
      Array of object

      These are procedures that are more observational in nature, such as an EEG or EKG.

      • Code
        string, null
        Probable

        A code describing the procedure that was performed. .
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the procedure that was performed.

      • AltCodes
        Array of object

        Alternate or translation codes for the procedure that was performed.

        • Code
          string, null
          Possible

          A code describing the procedure that was performed.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the procedure that was performed.

      • DateTime
        string, null
        Probable

        When the procedure was performed.

      • Status
        string, null
        Probable

        The status of the procedure.

      • TargetSite
        object
        • Code
          string, null
          Probable

          A code describing the location on the body where the procedure was performed.
          SNOMED CT

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the location on the body where the procedure was performed

        • AltCodes
          Array of object

          Alternate or translation codes for the location on the body where the procedure was performed

          • Code
            string, null
            Possible

            A code describing the location on the body where the procedure was performed

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the location on the body where the procedure was performed

      • Comments
        Array of object

        Free text comments about the procedure.

        • Text
          string, null
          Reliable

          The plain text comment.

    • Procedures
      Array of object

      These are procedures that alter the state of the body, such as an appendectomy or hip replacement.

      • Code
        string, null
        Probable

        A code describing the procedure that was performed. .
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the procedure that was performed.

      • AltCodes
        Array of object

        Alternate or translation codes for the procedure that was performed.

        • Code
          string, null
          Possible

          A code describing the procedure that was performed.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the procedure that was performed.

      • DateTime
        string, null
        Probable

        When the procedure was performed.

      • Status
        string, null
        Probable

        The status of the procedure.

      • TargetSite
        object
        • Code
          string, null
          Probable

          A code describing the location on the body where the procedure was performed.
          SNOMED CT

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the location on the body where the procedure was performed

        • AltCodes
          Array of object

          Alternate or translation codes for the location on the body where the procedure was performed

          • Code
            string, null
            Possible

            A code describing the location on the body where the procedure was performed

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the location on the body where the procedure was performed

      • Comments
        Array of object

        Free text comments about the procedure.

        • Text
          string, null
          Reliable

          The plain text comment.

    • Services
      Array of object

      These are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient.

      • Code
        string, null
        Probable

        A code describing the procedure that was performed. .
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the procedure that was performed.

      • AltCodes
        Array of object

        Alternate or translation codes for the procedure that was performed.

        • Code
          string, null
          Possible

          A code describing the procedure that was performed.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the procedure that was performed.

      • DateTime
        string, null
        Probable

        When the procedure was performed.

      • Status
        string, null
        Probable

        The status of the procedure.

      • Comments
        Array of object

        Free text comments about the procedure.

        • Text
          string, null
          Reliable

          The plain text comment.

  • ResolvedProblemsText
    string, null
    Reliable

    Free text form of the problems summary.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • ResolvedProblems
    Array of object

    An array of historical problems and diagnoses that are no longer being tracked.

    • StartDate
      string, null
      Probable

      When the problem was noticed.
      ISO 8601 Format

    • EndDate
      string, null
      Probable

      When the problem stopped (if it is not current).
      ISO 8601 Format

    • Code
      string, null
      Reliable

      A code describing the actual problem .
      SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009)

    • CodeSystem
      string, null
      Reliable

      ID of the coding system to which the code belongs in OID format.
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • CodeSystemName
      string, null
      Reliable

      Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • Name
      string, null
      Reliable

      Name of the actual problem

    • AltCodes
      Array of object

      Alternate or translation codes for the actual problem

      • Code
        string, null
        Possible

        A code describing the actual problem

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the actual problem

    • Category
      object
      • Code
        string, null
        Reliable

        A code describing the type of problem this is (complaint, diagnosis, symptom, etc.)

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the type of problem this is (complaint, diagnosis, symptom, etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for the type of problem this is (complaint, diagnosis, symptom, etc.)

        • Code
          string, null
          Possible

          A code describing the type of problem this is (complaint, diagnosis, symptom, etc.)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the type of problem this is (complaint, diagnosis, symptom, etc.)

    • Status
      object
      • Code
        string, null
        Probable

        A code describing the current state of the problem (active, inactive, resolved).
        HITSPProblemStatus

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the current state of the problem (active, inactive, resolved)

    • Comment
      string, null
      Possible

      Free text comment about the problem.
      This field is slated to be deprecated in favor of Comments[].Text

    • Comments
      Array of object

      Free text comments about the problem.

      • Text
        string, null
        Reliable

        The plain text comment.

  • ResultText
    string, null
    Reliable

    Free text form of the results summary.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • Results
    Array of object

    Array of test results for the patient. This can include laboratory results, imaging results, and procedure results.

    • Code
      string, null
      Reliable

      A code describing the test performed and resulted.
      LOINC for Lab, SNOMED CT otherwise

    • CodeSystem
      string, null
      Reliable

      ID of the coding system to which the code belongs in OID format.
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • CodeSystemName
      string, null
      Reliable

      Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
      Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

    • Name
      string, null
      Reliable

      Name of the test performed and resulted.

    • AltCodes
      Array of object

      Alternate or translation codes for the test performed and resulted.

      • Code
        string, null
        Possible

        A code describing the test performed and resulted.

      • CodeSystem
        string, null
        Possible

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Possible

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Possible

        Name of the test performed and resulted.

    • Encounter
      object

      Encounter associated with this result (if different from the encompassing encounter)

      • Identifiers
        Array of object

        List of IDs specific to this encounter

        • ID
          string, null
          Possible

          An ID specific to this encounter

        • IDType
          string, null
          Possible

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Status
        string, null
        Possible

        The status of the encounter

      • Type
        object
        • Code
          string, null
          Reliable

          A code describing the type of encounter (office visit, hospital, etc).
          CPT-4

        • CodeSystem
          string, null
          Reliable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Reliable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Reliable

          Name of the type of encounter (office visit, hospital, etc)

        • AltCodes
          Array of object

          Alternate or translation codes for the type of encounter (office visit, hospital, etc)

          • Code
            string, null
            Possible

            A code describing the type of encounter (office visit, hospital, etc)

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the type of encounter (office visit, hospital, etc)

      • DateTime
        string, null
        Reliable

        When the encounter took place, or alternatively when the encounter began if Results[].Encounter.EndDateTime is present.
        ISO 8601 Format

      • EndDateTime
        string, null
        Possible

        When the encounter was completed, if available.
        ISO 8601 Format

    • Status
      string, null
      Reliable

      The status of the test (In Progress, Final)

    • Producer
      object
      • ID
        string, null
        Possible

        ID of the producer for this result.
        The "Producer" is typically the Lab which did the resulting.

      • Name
        string, null
        Possible

        Name of the producer

      • IDType
        string, null
        Possible

        ID Type for the corresponding ID of this producer

      • Address
        object

        Result producer's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

        • Use
          string, null
          Possible

          Use

    • Specimen
      object

      Details about the target of focused laboratory, radiology or other observations

      • CollectionDateTime
        null, null
        Possible

        A specific date/time when the specimen was collected

      • Identifiers
        Array of string

        One or more unique identifiers for this specimen. Each may be a single OID or UUID, or it may be two values, separated by a ^.

      • Source
        object
        • Code
          string, null
          Possible

          A code describing code or name describing the specimen

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of code or name describing the specimen

      • TargetSite
        object
        • Code
          string, null
          Possible

          A code describing code specifying detail about the anatomical site or system that is the focus of the observation

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of code specifying detail about the anatomical site or system that is the focus of the observation

    • Observations
      Array of object

      A list of corresponding observations for the test (result components)

      • Code
        string, null
        Reliable

        A code describing the individual result component. .
        LOINC for Lab, SNOMED CT otherwise

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the individual result component.

      • AltCodes
        Array of object

        Alternate or translation codes for the individual result component.

        • Code
          string, null
          Possible

          A code describing the individual result component.

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the individual result component.

      • Status
        string, null
        Reliable

        The status of the individual component. Some tests may have different components finish at different times. .
        One of (In Progress, Final)

      • Interpretation
        string, null
        Probable

        A flag indicating whether or not the observed value is normal, high, or low.
        Supported Values

      • DateTime
        string, null
        Reliable

        A specific date/time when the value was recorded.
        ISO 8601 Format

      • CodedValue
        object
        • Code
          string, null
          Possible

          A code describing the individual result value.
          Only populated if the result is sent as a coded value. Observations[].CodedValue.Name will be duplicated in Observations[].Value

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the individual result value.

        • AltCodes
          Array of object

          Alternate or translation codes for the individual result value.

          • Code
            string, null
            Possible

            A code describing the individual result value.

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the individual result value.

      • Value
        string, null
        Reliable

        The measurement recorded for the result.

      • ValueType
        string, null
        Reliable

        The type and format of the value.
        One of the following: PhysicalQuantity, String, Number, Interval, Ratio, Code, Encapsulated Data. Intervals will be represented in Value as low-high, <low, <=low, >high, or >=high. Ratios will be represented in Value as numerator:denominator.

      • FileType
        string, null
        Possible

        The file content type of the encapsulated data.
        Only available when ValueType is Encapsulated Data

      • Units
        string, null
        Reliable

        The units of the measurement.
        Only available when ValueType is PhysicalQuantity

      • ReferenceRange
        object

        Reference range for the result.
        Numeric result values will use the low and high properties. Non-numeric result values will put the normal value in the text property.

        • Low
          string, null
          Possible

          Lower bound for a normal result

        • High
          string, null
          Possible

          Upper bound for a normal result

        • Text
          string, null
          Possible

          The normal value for non-numeric results

      • Comments
        Array of object

        Free text comments about the result.

        • Text
          string, null
          Reliable

          The plain text comment.

  • SocialHistoryText
    string, null
    Probable

    Free text form of the social history summary

  • SocialHistory
    object
    • Observations
      Array of object

      Generic observations about the patient's social history that don't fall into the smoking or pregnancy categories.

      • Code
        string, null
        Probable

        A code describing a type of social history observation (exercise, alcohol intake, etc.) .
        SNOMED CT

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of a type of social history observation (exercise, alcohol intake, etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for a type of social history observation (exercise, alcohol intake, etc.)

        • Code
          string, null
          Possible

          A code describing a type of social history observation (exercise, alcohol intake, etc.)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of a type of social history observation (exercise, alcohol intake, etc.)

      • Value
        object

        The observed value

        • Code
          string, null
          Probable

          A code describing the observed value, if coded

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the observed value, if coded

        • AltCodes
          Array of object

          Alternate or translation codes for the observed value, if coded

          • Code
            string, null
            Possible

            A code describing the observed value, if coded

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the observed value, if coded

      • ValueText
        string, null
        Probable

        The observed value, if un-coded

      • Units
        string, null
        Possible

        The units of the measurement, if the observed value is a quantity.
        UCUM Units of Measure

      • StartDate
        string, null
        Probable

        Start date of status

      • EndDate
        string, null
        Probable

        Date status ended. If this is null, the status is current.

      • Comments
        Array of object

        Free text comments about the observation.

        • Text
          string, null
          Reliable

          The plain text comment.

    • Pregnancy
      Array of object

      Information about past and current pregnancies.

      • StartDate
        string, null
        Probable

        When the pregnancy started.
        ISO 8601 Format

      • EndDate
        string, null
        Probable

        When the pregnancy ended.
        ISO 8601 Format

      • EstimatedDelivery
        string, null
        Probable

        Estimate delivery date if pregnancy is still active.

      • Comments
        Array of object

        Free text comments about the pregnancy.

        • Text
          string, null
          Reliable

          The plain text comment.

    • TobaccoUse
      Array of object

      Contains tobacco use and smoking status observations

      • Code
        string, null
        Probable

        A code describing the use of tobacco (current smoker, never smoker, snuff user, etc.).
        Contains all values descending from the SNOMED CT® 365980008 tobacco use and exposure - finding hierarchy

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Probable

        Name of the use of tobacco (current smoker, never smoker, snuff user, etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for the use of tobacco (current smoker, never smoker, snuff user, etc.)

        • Code
          string, null
          Possible

          A code describing the use of tobacco (current smoker, never smoker, snuff user, etc.)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the use of tobacco (current smoker, never smoker, snuff user, etc.)

      • IsSmokingStatus
        boolean, null
        Probable

        Identifies this tobacco use entry as a smoking status.
        If true, StartDate is the date the smoking status was observed.

      • StartDate
        string, null
        Probable

        Start date of status.
        If IsSmokingStatus is true, this is the date the observation was made.

      • EndDate
        string, null
        Probable

        Date status ended. If this is null, the status is current.

      • Comments
        Array of object

        Free text comments about the observation.

        • Text
          string, null
          Reliable

          The plain text comment.

  • VitalSignsText
    string, null
    Probable

    Free text form of the vital signs summary.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • VitalSigns
    Array of object

    An array of groups of vital signs.

    • DateTime
      string, null
      Possible

      The date and time of the group of readings.
      This field is deprecated since vital readings are not necessarily always grouped by time. Instead, the Observations[].DateTime tells when an individual reading took place.

    • Observations
      Array of object

      An array of individual vital sign Observations[].

      • Code
        string, null
        Reliable

        A code describing the type of vital sign being read (height, weight, blood pressure, etc.).
        LOINC (HITSP Vital Sign Result Type).

      • CodeSystem
        string, null
        Reliable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Reliable

        Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • Name
        string, null
        Reliable

        Name of the type of vital sign being read (height, weight, blood pressure, etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for the type of vital sign being read (height, weight, blood pressure, etc.)

        • Code
          string, null
          Possible

          A code describing the type of vital sign being read (height, weight, blood pressure, etc.)

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Possible

          Name of the type of vital sign being read (height, weight, blood pressure, etc.)

      • Status
        string, null
        Reliable

        The status of the reading (usually completed)

      • Interpretation
        string, null
        Probable

        A flag indicating whether or not the observed value is normal, high, or low.
        Supported Values

      • DateTime
        string, null
        Reliable

        The date/time when the specific vital sign was recorded.
        ISO 8601 Format

      • Value
        string, null
        Reliable

        The measurement recorded for the vital sign.

      • Units
        string, null
        Reliable

        The units of the measurement.
        UCUM Units of Measure

      • TargetSite
        object
        • Code
          string, null
          Probable

          A code describing the location on the body where the procedure was performed.
          SNOMED CT

        • CodeSystem
          string, null
          Probable

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Probable

          Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • Name
          string, null
          Probable

          Name of the location on the body where the procedure was performed

        • AltCodes
          Array of object

          Alternate or translation codes for the location on the body where the procedure was performed

          • Code
            string, null
            Possible

            A code describing the location on the body where the procedure was performed

          • CodeSystem
            string, null
            Possible

            ID of the coding system to which the code belongs in OID format.
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • CodeSystemName
            string, null
            Possible

            Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
            Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

          • Name
            string, null
            Possible

            Name of the location on the body where the procedure was performed

      • Comments
        Array of object

        Free text comments about the vital sign.

        • Text
          string, null
          Reliable

          The plain text comment.

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Clinical Summary",
4
    "EventType": "PatientQueryResponse",
5
    "EventDateTime": "2024-11-18T21:23:08.746Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "ef9e7448-7f65-4432-aa96-059647e9b358",
14
        "Name": "Patient Query Endpoint"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Header": {
26
    "Document": {
27
      "Author": {
28
        "ID": "4356789876",
29
        "IDType": "2.16.840.1.113883.4.6",
30
        "FirstName": "Pat",
31
        "LastName": "Granite",
32
        "Credentials": [
33
          "MD"
34
        ],
35
        "Address": {
36
          "StreetAddress": "123 Main St.",
37
          "City": "Madison",
38
          "State": "WI",
39
          "ZIP": "53703",
40
          "County": "Dane",
41
          "Country": "USA"
42
        },
43
        "EmailAddresses": [],
44
        "PhoneNumber": {
45
          "Office": "+16085551234"
46
        },
47
        "Type": null,
48
        "Location": {
49
          "Type": null,
50
          "Facility": null,
51
          "FacilityIdentifiers": [],
52
          "Department": null,
53
          "DepartmentIdentifiers": [],
54
          "Room": null
55
        }
56
      },
57
      "ID": "75cb4ad4-e5f9-4cd3-8750-eb5050521e0d",
58
      "SetID": null,
59
      "VersionNumber": null,
60
      "RelatesTo": [],
61
      "Locale": "US",
62
      "Title": "Community Health and Hospitals: Health Summary",
63
      "DateTime": "2012-09-12T00:00:00.000Z",
64
      "Type": "Summarization of Episode Note",
65
      "TypeCode": {
66
        "Code": "34133-9",
67
        "CodeSystem": "2.16.840.1.113883.6.1",
68
        "CodeSystemName": "LOINC",
69
        "Name": "Summarization of Episode Note"
70
      },
71
      "Confidentiality": {
72
        "Code": "N",
73
        "CodeSystem": "2.16.840.1.113883.5.25",
74
        "CodeSystemName": "Confidentiality",
75
        "Name": "normal"
76
      },
77
      "Custodian": {
78
        "Identifiers": [],
79
        "Name": null,
80
        "Type": {
81
          "Code": null,
82
          "CodeSystem": null,
83
          "CodeSystemName": null,
84
          "Name": null,
85
          "AltCodes": []
86
        },
87
        "Address": {
88
          "StreetAddress": null,
89
          "City": null,
90
          "State": null,
91
          "ZIP": null,
92
          "County": null,
93
          "Country": null,
94
          "Use": null
95
        },
96
        "Telecom": []
97
      }
98
    },
99
    "Patient": {
100
      "Identifiers": [
101
        {
102
          "ID": "1234",
103
          "IDType": "2.16.840.1.113883.4.6",
104
          "Type": null
105
        }
106
      ],
107
      "Demographics": {
108
        "FirstName": "Myra",
109
        "MiddleName": null,
110
        "LastName": "Jones",
111
        "DOB": "1947-05-01",
112
        "SSN": "123-101-1234",
113
        "Sex": "Female",
114
        "Address": {
115
          "StreetAddress": "1357 Amber Drive",
116
          "City": "Beaverton",
117
          "State": "OR",
118
          "County": null,
119
          "Country": "US",
120
          "ZIP": "97006",
121
          "Use": null
122
        },
123
        "PhoneNumber": {
124
          "Home": "+18162766909",
125
          "Mobile": null
126
        },
127
        "EmailAddresses": [
128
          {
129
            "Address": "12313124@fake.com"
130
          }
131
        ],
132
        "Language": null,
133
        "Race": "White",
134
        "RaceCodes": [
135
          {
136
            "Code": "2106-3",
137
            "CodeSystem": "2.16.840.1.113883.6.238",
138
            "CodeSystemName": "CDC Race and Ethnicity",
139
            "Name": "White"
140
          },
141
          {
142
            "Code": "2112-1",
143
            "CodeSystem": "2.16.840.1.113883.6.238",
144
            "CodeSystemName": "CDC Race and Ethnicity",
145
            "Name": "German"
146
          }
147
        ],
148
        "Ethnicity": "Hispanic or Latino",
149
        "EthnicGroupCodes": [
150
          {
151
            "Code": "2135-2",
152
            "CodeSystem": "2.16.840.1.113883.6.238",
153
            "CodeSystemName": "CDC Race and Ethnicity",
154
            "Name": "Hispanic or Latino"
155
          },
156
          {
157
            "Code": "2149-3",
158
            "CodeSystem": "2.16.840.1.113883.6.238",
159
            "CodeSystemName": "CDC Race and Ethnicity",
160
            "Name": "Mexican American"
161
          }
162
        ],
163
        "Religion": "Christian (non-Catholic, non-specific)",
164
        "MaritalStatus": "Married",
165
        "IsDeceased": false,
166
        "DeathDateTime": null
167
      },
168
      "Organization": {
169
        "Identifiers": [],
170
        "Name": null,
171
        "Type": {
172
          "Code": null,
173
          "CodeSystem": null,
174
          "CodeSystemName": null,
175
          "Name": null,
176
          "AltCodes": []
177
        },
178
        "Address": {
179
          "StreetAddress": null,
180
          "City": null,
181
          "State": null,
182
          "ZIP": null,
183
          "County": null,
184
          "Country": null,
185
          "Use": null
186
        },
187
        "Telecom": []
188
      }
189
    },
190
    "PCP": {
191
      "ID": null,
192
      "IDType": null,
193
      "FirstName": null,
194
      "LastName": null,
195
      "Credentials": [],
196
      "Address": {
197
        "StreetAddress": null,
198
        "City": null,
199
        "State": null,
200
        "ZIP": null,
201
        "County": null,
202
        "Country": null
203
      },
204
      "EmailAddresses": [],
205
      "PhoneNumber": {
206
        "Office": null
207
      },
208
      "Type": null,
209
      "Location": {
210
        "Type": null,
211
        "Facility": null,
212
        "FacilityIdentifiers": [],
213
        "Department": null,
214
        "DepartmentIdentifiers": [],
215
        "Room": null
216
      }
217
    }
218
  },
219
  "AdvanceDirectivesText": "<table width=\"100%\"><thead><tr><th>Directive</th><th>Description</th><th>Verification</th><th>Supporting Document(s)</th></tr></thead><tbody><tr><td>Resuscitation status</td><td ID=\"AD1\">Do not resuscitate</td><td>Dr. Robert Dolin, Nov 07, 1999</td><td><linkHtml href=\"AdvanceDirective.b50b7910-7ffb-4f4c-bbe4-177ed68cbbf3.pdf\">Advance directive</linkHtml></td></tr></tbody></table>",
220
  "AdvanceDirectives": [
221
    {
222
      "Type": {
223
        "Code": "304251008",
224
        "CodeSystem": "2.16.840.1.113883.6.96",
225
        "CodeSystemName": "SNOMED CT",
226
        "Name": "Resuscitation",
227
        "AltCodes": []
228
      },
229
      "Code": "304253006",
230
      "CodeSystem": "2.16.840.1.113883.6.96",
231
      "CodeSystemName": "SNOMED CT",
232
      "Name": "Do not resuscitate",
233
      "AltCodes": [],
234
      "StartDate": "2011-02-13T05:00:00.000Z",
235
      "EndDate": null,
236
      "ExternalReference": "AdvanceDirective.b50b7910-7ffb-4f4c-bbe4-177ed68cbbf3.pdf",
237
      "VerifiedBy": [
238
        {
239
          "FirstName": "Robert",
240
          "LastName": "Dolin",
241
          "Credentials": "Dr.",
242
          "DateTime": null
243
        }
244
      ],
245
      "Custodians": [
246
        {
247
          "FirstName": "Robert",
248
          "LastName": "Dolin",
249
          "Credentials": "Dr.",
250
          "Address": {
251
            "StreetAddress": "21 North Ave.",
252
            "City": "Burlington",
253
            "State": "MA",
254
            "Country": "USA",
255
            "ZIP": "02368"
256
          }
257
        }
258
      ]
259
    }
260
  ],
261
  "AllergyText": "<table width=\"100%\"><thead><tr><th>Substance</th><th>Reaction</th><th>Severity</th><th>Status</th></tr></thead><tbody><tr><td>Penicillin G benzathine</td><td ID=\"reaction1\">Hives</td><td ID=\"severity1\">Moderate to severe</td><td>Inactive</td></tr><tr><td>Codeine</td><td ID=\"reaction2\">Shortness of Breath</td><td ID=\"severity2\">Moderate</td><td>Active</td></tr><tr><td>Aspirin</td><td ID=\"reaction3\">Hives</td><td ID=\"severity3\">Mild to moderate</td><td>Active</td></tr></tbody></table>",
262
  "Allergies": [
263
    {
264
      "Type": {
265
        "Code": "419511003",
266
        "CodeSystem": "2.16.840.1.113883.6.96",
267
        "CodeSystemName": "SNOMED CT",
268
        "Name": "Propensity to adverse reaction to drug",
269
        "AltCodes": []
270
      },
271
      "Substance": {
272
        "Code": "7982",
273
        "CodeSystem": "2.16.840.1.113883.6.88",
274
        "CodeSystemName": "RxNorm",
275
        "Name": "Penicillin G benzathine",
276
        "AltCodes": []
277
      },
278
      "Reaction": [
279
        {
280
          "Code": "28926001",
281
          "CodeSystem": "2.16.840.1.113883.6.96",
282
          "CodeSystemName": "SNOMED CT",
283
          "Name": "Rash",
284
          "AltCodes": [],
285
          "Severity": {
286
            "Code": "255604002",
287
            "CodeSystem": "2.16.840.1.113883.6.96",
288
            "CodeSystemName": "SNOMED CT",
289
            "Name": "Mild"
290
          },
291
          "Text": null
292
        },
293
        {
294
          "Code": "247472004",
295
          "CodeSystem": "2.16.840.1.113883.6.96",
296
          "CodeSystemName": "SNOMED CT",
297
          "Name": "Hives",
298
          "AltCodes": [],
299
          "Severity": {
300
            "Code": "6736007",
301
            "CodeSystem": "2.16.840.1.113883.6.96",
302
            "CodeSystemName": "SNOMED CT",
303
            "Name": "Moderate"
304
          },
305
          "Text": null
306
        }
307
      ],
308
      "Severity": {
309
        "Code": "6736007",
310
        "CodeSystem": "2.16.840.1.113883.6.96",
311
        "CodeSystemName": "SNOMED CT",
312
        "Name": "Moderate"
313
      },
314
      "Criticality": {
315
        "Code": "CRITH",
316
        "CodeSystem": "2.16.840.1.113883.5.1063",
317
        "CodeSystemName": "ObservationValue",
318
        "Name": "High criticality"
319
      },
320
      "Status": {
321
        "Code": "73425007",
322
        "CodeSystem": "2.16.840.1.113883.6.96",
323
        "CodeSystemName": "SNOMED CT",
324
        "Name": "Inactive"
325
      },
326
      "IsNegativeIndicator": null,
327
      "StartDate": null,
328
      "EndDate": null,
329
      "Comment": null,
330
      "Comments": [
331
        {
332
          "Text": "Noted when patient took penicillin for ear infection."
333
        }
334
      ]
335
    },
336
    {
337
      "Type": {
338
        "Code": "419511003",
339
        "CodeSystem": "2.16.840.1.113883.6.96",
340
        "CodeSystemName": "SNOMED CT",
341
        "Name": "Propensity to adverse reaction to drug",
342
        "AltCodes": []
343
      },
344
      "Substance": {
345
        "Code": "2670",
346
        "CodeSystem": "2.16.840.1.113883.6.88",
347
        "CodeSystemName": "RxNorm",
348
        "Name": "Codeine",
349
        "AltCodes": [
350
          {
351
            "Code": "11QV9BS0CB",
352
            "CodeSystem": "2.16.840.1.113883.4.9",
353
            "CodeSystemName": "UNII",
354
            "Name": "Codeine"
355
          }
356
        ]
357
      },
358
      "Reaction": [
359
        {
360
          "Code": "267036007",
361
          "CodeSystem": "2.16.840.1.113883.6.96",
362
          "CodeSystemName": "SNOMED CT",
363
          "Name": "Shortness of Breath",
364
          "AltCodes": [],
365
          "Severity": {
366
            "Code": "6736007",
367
            "CodeSystem": "2.16.840.1.113883.6.96",
368
            "CodeSystemName": "SNOMED CT",
369
            "Name": "Moderate"
370
          },
371
          "Text": null
372
        }
373
      ],
374
      "Severity": {
375
        "Code": "6736007",
376
        "CodeSystem": "2.16.840.1.113883.6.96",
377
        "CodeSystemName": "SNOMED CT",
378
        "Name": "Moderate"
379
      },
380
      "Criticality": {
381
        "Code": "CRITL",
382
        "CodeSystem": "2.16.840.1.113883.5.1063",
383
        "CodeSystemName": "ObservationValue",
384
        "Name": "Low criticality"
385
      },
386
      "Status": {
387
        "Code": "55561003",
388
        "CodeSystem": "2.16.840.1.113883.6.96",
389
        "CodeSystemName": "SNOMED CT",
390
        "Name": "Active"
391
      },
392
      "IsNegativeIndicator": null,
393
      "StartDate": null,
394
      "EndDate": null,
395
      "Comment": null,
396
      "Comments": []
397
    },
398
    {
399
      "Type": {
400
        "Code": "419511003",
401
        "CodeSystem": "2.16.840.1.113883.6.96",
402
        "CodeSystemName": "SNOMED CT",
403
        "Name": "Propensity to adverse reaction to drug",
404
        "AltCodes": []
405
      },
406
      "Substance": {
407
        "Code": "1191",
408
        "CodeSystem": "2.16.840.1.113883.6.88",
409
        "CodeSystemName": "RxNorm",
410
        "Name": "Aspirin",
411
        "AltCodes": []
412
      },
413
      "Reaction": [
414
        {
415
          "Code": "247472004",
416
          "CodeSystem": "2.16.840.1.113883.6.96",
417
          "CodeSystemName": "SNOMED CT",
418
          "Name": "Hives",
419
          "AltCodes": [],
420
          "Severity": {
421
            "Code": "371923003",
422
            "CodeSystem": "2.16.840.1.113883.6.96",
423
            "CodeSystemName": "SNOMED CT",
424
            "Name": "Mild to moderate"
425
          },
426
          "Text": null
427
        }
428
      ],
429
      "Severity": {
430
        "Code": "371923003",
431
        "CodeSystem": "2.16.840.1.113883.6.96",
432
        "CodeSystemName": "SNOMED CT",
433
        "Name": "Mild to moderate"
434
      },
435
      "Criticality": {
436
        "Code": "CRITU",
437
        "CodeSystem": "2.16.840.1.113883.5.1063",
438
        "CodeSystemName": "ObservationValue",
439
        "Name": "Unable to assess criticality"
440
      },
441
      "Status": {
442
        "Code": "55561003",
443
        "CodeSystem": "2.16.840.1.113883.6.96",
444
        "CodeSystemName": "SNOMED CT",
445
        "Name": "Active"
446
      },
447
      "IsNegativeIndicator": null,
448
      "StartDate": null,
449
      "EndDate": null,
450
      "Comment": null,
451
      "Comments": []
452
    }
453
  ],
454
  "CareTeamsText": "<table ID=\"ct39\"> <colgroup> <col span=\"3\" width=\"25%\"/> <col width=\"13%\"/> <col width=\"12%\"/> </colgroup> <thead> <tr> <th>Team Member</th> <th>Relationship</th> <th>Specialty</th> <th>Start Date</th> <th>End Date</th> </tr> </thead> <tbody> <tr styleCode=\"xRowNormal\"> <td> <paragraph styleCode=\"Bold\">Granite, Pat, MD</paragraph> <paragraph>NPI: 4356789876</paragraph> <paragraph>123 Main St.</paragraph> <paragraph>Madison, WI 53703</paragraph> </td> <td>PCP - General</td> <td>General Practice</td> <td>12/23/22</td> <td/> </tr> </tbody> </table>",
455
  "CareTeams": [
456
    {
457
      "Name": null,
458
      "Status": "active",
459
      "Types": [],
460
      "Organization": {
461
        "Identifiers": [],
462
        "Name": null,
463
        "Type": {
464
          "Code": null,
465
          "CodeSystem": null,
466
          "CodeSystemName": null,
467
          "Name": null,
468
          "AltCodes": []
469
        },
470
        "Address": {
471
          "StreetAddress": null,
472
          "City": null,
473
          "State": null,
474
          "ZIP": null,
475
          "County": null,
476
          "Country": null,
477
          "Use": null
478
        },
479
        "Telecom": []
480
      },
481
      "Encounter": {
482
        "Identifiers": [],
483
        "Status": null,
484
        "Type": {
485
          "Code": null,
486
          "CodeSystem": null,
487
          "CodeSystemName": null,
488
          "Name": null,
489
          "AltCodes": []
490
        },
491
        "DateTime": null,
492
        "EndDateTime": null
493
      },
494
      "Members": [
495
        {
496
          "Identifiers": [
497
            {
498
              "ID": "4356789876",
499
              "IDType": "2.16.840.1.113883.4.6"
500
            }
501
          ],
502
          "FirstName": "Pat",
503
          "MiddleName": "Marie",
504
          "LastName": "Granite",
505
          "Credentials": [
506
            "MD"
507
          ],
508
          "Address": {
509
            "StreetAddress": "123 Main St.",
510
            "City": "Madison",
511
            "State": "WI",
512
            "ZIP": "53703",
513
            "County": "Dane",
514
            "Country": "USA",
515
            "Use": null
516
          },
517
          "Telecom": [],
518
          "StartDateTime": "2022-12-23",
519
          "EndDateTime": null,
520
          "Roles": [
521
            {
522
              "Code": "PCP",
523
              "CodeSystem": "2.16.840.1.113883.5.88",
524
              "CodeSystemName": "ParticipationFunction",
525
              "Name": "General",
526
              "AltCodes": []
527
            },
528
            {
529
              "Code": "PPRF",
530
              "CodeSystem": "2.16.840.1.113883.5.90",
531
              "CodeSystemName": "ParticipationType",
532
              "Name": "primary performer",
533
              "AltCodes": []
534
            }
535
          ]
536
        }
537
      ]
538
    }
539
  ],
540
  "EncountersText": "<table width=\"100%\"><thead><tr><th>Encounter</th><th>Performer</th><th>Location</th><th>Date</th></tr></thead><tbody><tr ID=\"Encounter1\"><td>&#xD;\nPnuemonia</td><td>Dr Henry Seven</td><td>Community Health and Hospitals</td><td>20120806</td></tr></tbody></table>",
541
  "Encounters": [
542
    {
543
      "Identifiers": [
544
        {
545
          "ID": "2376492",
546
          "IDType": "URMC Epic CSN"
547
        },
548
        {
549
          "ID": "8237334",
550
          "IDType": "1.35.829.5.238422.9.10"
551
        }
552
      ],
553
      "Status": null,
554
      "Type": {
555
        "Code": "99222",
556
        "CodeSystem": "2.16.840.1.113883.6.12",
557
        "CodeSystemName": "CPT",
558
        "Name": "InPatient Admission",
559
        "AltCodes": []
560
      },
561
      "DateTime": "2012-08-06T04:00:00.000Z",
562
      "EndDateTime": null,
563
      "Providers": [
564
        {
565
          "NPI": null,
566
          "ID": null,
567
          "IDType": null,
568
          "FirstName": null,
569
          "LastName": null,
570
          "Credentials": [],
571
          "Address": {
572
            "StreetAddress": null,
573
            "City": null,
574
            "State": null,
575
            "ZIP": null,
576
            "County": null,
577
            "Country": null
578
          },
579
          "EmailAddresses": [],
580
          "PhoneNumber": {
581
            "Office": null
582
          },
583
          "Location": {
584
            "Type": null,
585
            "Facility": null,
586
            "FacilityIdentifiers": [],
587
            "Department": null,
588
            "DepartmentIdentifiers": [],
589
            "Room": null
590
          },
591
          "Role": {
592
            "Code": "59058001",
593
            "CodeSystem": "2.16.840.1.113883.6.96",
594
            "CodeSystemName": "SNOMED CT",
595
            "Name": "General Physician",
596
            "AltCodes": []
597
          }
598
        }
599
      ],
600
      "Locations": [
601
        {
602
          "Identifiers": [],
603
          "Telecom": [],
604
          "Address": {
605
            "StreetAddress": "1002 Healthcare Dr",
606
            "City": "Portland",
607
            "State": "OR",
608
            "Country": "US",
609
            "ZIP": "97266"
610
          },
611
          "Type": {
612
            "Code": "1160-1",
613
            "CodeSystem": "2.16.840.1.113883.6.259",
614
            "CodeSystemName": "HealthcareServiceLocation",
615
            "Name": "Urgent Care Center",
616
            "AltCodes": []
617
          },
618
          "Name": "Community Health and Hospitals"
619
        }
620
      ],
621
      "Diagnosis": [
622
        {
623
          "StartDate": "2012-08-06T04:00:00.000Z",
624
          "EndDate": null,
625
          "Status": {
626
            "Code": null,
627
            "CodeSystem": null,
628
            "CodeSystemName": null,
629
            "Name": "active"
630
          },
631
          "IsNegativeIndicator": null,
632
          "Code": "233604007",
633
          "CodeSystem": "2.16.840.1.113883.6.96",
634
          "CodeSystemName": "SNOMED CT",
635
          "Name": "Pneumonia",
636
          "AltCodes": [],
637
          "Comments": []
638
        }
639
      ],
640
      "ReasonForVisit": [
641
        {
642
          "Code": "233604007",
643
          "CodeSystem": "2.16.840.1.113883.6.96",
644
          "CodeSystemName": "SNOMED CT",
645
          "Name": "Pneumonia",
646
          "AltCodes": []
647
        }
648
      ],
649
      "DischargeDisposition": {
650
        "Code": null,
651
        "CodeSystem": null,
652
        "CodeSystemName": null,
653
        "Name": null,
654
        "AltCodes": []
655
      }
656
    }
657
  ],
658
  "FamilyHistoryText": "<paragraph>Father (deceased)</paragraph><table width=\"100%\"><thead><tr><th>Diagnosis</th><th>Age At Onset</th></tr></thead><tbody><tr><td>Myocardial Infarction (cause of death)</td><td>57</td></tr><tr><td>Diabetes</td><td>40</td></tr></tbody></table>",
659
  "FamilyHistory": [
660
    {
661
      "Relation": {
662
        "Code": "FTH",
663
        "CodeSystem": "2.16.840.1.113883.5.111",
664
        "CodeSystemName": "HL7 FamilyMember",
665
        "Name": "Father",
666
        "Demographics": {
667
          "Sex": "Male",
668
          "DOB": "1912-01-01"
669
        },
670
        "IsDeceased": true
671
      },
672
      "Problems": [
673
        {
674
          "Code": "22298006",
675
          "CodeSystem": "2.16.840.1.113883.6.96",
676
          "CodeSystemName": "SNOMED CT",
677
          "Name": "Myocardial infarction",
678
          "AltCodes": [],
679
          "Type": {
680
            "Code": "55607006",
681
            "CodeSystem": "2.16.840.1.113883.6.96",
682
            "CodeSystemName": "SNOMED CT",
683
            "Name": "Problem"
684
          },
685
          "DateTime": null,
686
          "AgeAtOnset": "57",
687
          "IsCauseOfDeath": null
688
        },
689
        {
690
          "Code": "46635009",
691
          "CodeSystem": "2.16.840.1.113883.6.96",
692
          "CodeSystemName": "SNOMED CT",
693
          "Name": "Diabetes mellitus type 1",
694
          "AltCodes": [],
695
          "Type": {
696
            "Code": "64572001",
697
            "CodeSystem": "2.16.840.1.113883.6.96",
698
            "CodeSystemName": "SNOMED CT",
699
            "Name": "Condition"
700
          },
701
          "DateTime": "1994-01-01T05:00:00.000Z",
702
          "AgeAtOnset": "40",
703
          "IsCauseOfDeath": null
704
        }
705
      ]
706
    }
707
  ],
708
  "FunctionalStatusText": "<table><thead><tr><th>Assessment</th><th>Date</th><th>Results</th><th>Comments</th></tr></thead><tbody><tr ID=\"FS_Narrative1\"><td ID=\"FS_Type\">Functional Status</td><td>August 15 2012, 5:32pm</td><td ID=\"FS_Finding1\">Dependence on walking stick</td><td></td></tr><tr ID=\"FS_Narrative2\"><td ID=\"FS_Type\">Functional Status</td><td>March 11 2013</td><td ID=\"FS_Finding1\">Independent with dressing</td><td></td></tr><tr ID=\"FS_Narrative3\"><td ID=\"FS_Type\">Transferring</td><td>March 11 2013</td><td ID=\"FS_Finding1\">Independent</td><td></td></tr><tr ID=\"FS_Narrative4\"><td ID=\"FS_Type\">Hearing</td><td>March 11 2013</td><td ID=\"FS_Finding1\">Impaired</td><td></td></tr></tbody></table>",
709
  "FunctionalStatus": {
710
    "Observations": [
711
      {
712
        "Code": "54522-8",
713
        "CodeSystem": "2.16.840.1.113883.6.1",
714
        "CodeSystemName": "LOINC",
715
        "Name": "Functional Status",
716
        "AltCodes": [],
717
        "DateTime": "2012-08-15",
718
        "CodedValue": {
719
          "Code": "105504002",
720
          "CodeSystem": "2.16.840.1.113883.6.96",
721
          "CodeSystemName": "SNOMED CT",
722
          "Name": "Dependence on walking stick",
723
          "AltCodes": []
724
        },
725
        "Value": "Dependence on walking stick",
726
        "Units": null,
727
        "ReferenceRange": {
728
          "Low": null,
729
          "High": null,
730
          "Text": null
731
        },
732
        "Comments": []
733
      },
734
      {
735
        "Code": "54522-8",
736
        "CodeSystem": "2.16.840.1.113883.6.1",
737
        "CodeSystemName": "LOINC",
738
        "Name": "Functional Status",
739
        "AltCodes": [],
740
        "DateTime": "2013-03-11",
741
        "CodedValue": {
742
          "Code": "129035000",
743
          "CodeSystem": "2.16.840.1.113883.6.96",
744
          "CodeSystemName": "SNOMED CT",
745
          "Name": "Independent with dressing",
746
          "AltCodes": []
747
        },
748
        "Value": "Independent with dressing",
749
        "Units": null,
750
        "ReferenceRange": {
751
          "Low": null,
752
          "High": null,
753
          "Text": null
754
        },
755
        "Comments": []
756
      },
757
      {
758
        "Code": "46482-6",
759
        "CodeSystem": "2.16.840.1.113883.6.1",
760
        "CodeSystemName": "LOINC",
761
        "Name": "Transferring",
762
        "AltCodes": [],
763
        "DateTime": "2013-03-11",
764
        "CodedValue": {
765
          "Code": "371153006",
766
          "CodeSystem": "2.16.840.1.113883.6.96",
767
          "CodeSystemName": "SNOMED CT",
768
          "Name": "Independent",
769
          "AltCodes": []
770
        },
771
        "Value": "Independent",
772
        "Units": null,
773
        "ReferenceRange": {
774
          "Low": null,
775
          "High": null,
776
          "Text": null
777
        },
778
        "Comments": []
779
      },
780
      {
781
        "Code": "47078008",
782
        "CodeSystem": "2.16.840.1.113883.6.96",
783
        "CodeSystemName": "SNOMED CT",
784
        "Name": "Hearing",
785
        "AltCodes": [],
786
        "DateTime": "2013-03-11",
787
        "CodedValue": {
788
          "Code": "260379002",
789
          "CodeSystem": "2.16.840.1.113883.6.96",
790
          "CodeSystemName": "SNOMED CT",
791
          "Name": "Impaired",
792
          "AltCodes": []
793
        },
794
        "Value": "Impaired",
795
        "Units": null,
796
        "ReferenceRange": {
797
          "Low": null,
798
          "High": null,
799
          "Text": null
800
        },
801
        "Comments": []
802
      }
803
    ],
804
    "Supplies": [
805
      {
806
        "Code": "14106009",
807
        "CodeSystem": "2.16.840.1.113883.6.96",
808
        "CodeSystemName": "SNOMED CT",
809
        "Name": "Cardiac Pacemaker",
810
        "AltCodes": [],
811
        "Status": "completed",
812
        "DateTime": "2013-07-03"
813
      }
814
    ]
815
  },
816
  "GoalsText": "<paragraph ID=\"Goals\">Patient is targeting a pulse oximetry of 92%</paragraph>",
817
  "Goals": [
818
    {
819
      "Code": "59408-5",
820
      "CodeSystem": "2.16.840.1.113883.6.1",
821
      "CodeSystemName": "LOINC",
822
      "Name": "Oxygen saturation in Arterial blood by Pulse oximetry",
823
      "AltCodes": [],
824
      "DateTime": "2012-12-31T23:59:59.999Z",
825
      "CodedValue": {
826
        "Code": null,
827
        "CodeSystem": null,
828
        "CodeSystemName": null,
829
        "Name": null,
830
        "AltCodes": []
831
      },
832
      "Value": "92",
833
      "Units": "%",
834
      "StartDate": "2013-09-02",
835
      "EndDate": "2013-09-02",
836
      "Priority": {
837
        "Code": "394849002",
838
        "CodeSystem": "2.16.840.1.113883.6.96",
839
        "CodeSystemName": "SNOMED CT",
840
        "Name": "High priority"
841
      },
842
      "AchievementStatus": {
843
        "Code": null,
844
        "CodeSystem": null,
845
        "CodeSystemName": null,
846
        "Name": "On track"
847
      },
848
      "Milestones": [],
849
      "Comments": []
850
    }
851
  ],
852
  "HealthConcernsText": "<table><thead><tr><th>Health Concern</th><th>Date</th><th>Related Problem</th></tr></thead><tbody><tr ID=\"Concern1\"><td ID=\"Concern1Issue1\">Concerned about being contagious and infecting roommate.</td><td>Concern from 03/02/2014</td><td>Community Acquired Pneumonia</td></tr></tbody></table>",
853
  "HealthConcerns": [
854
    {
855
      "ConcernType": null,
856
      "Category": {
857
        "Code": null,
858
        "CodeSystem": null,
859
        "CodeSystemName": null,
860
        "Name": null,
861
        "AltCodes": []
862
      },
863
      "StartDate": "2012-08-06T04:00:00.000Z",
864
      "EndDate": null,
865
      "Code": "385093006",
866
      "CodeSystem": "2.16.840.1.113883.6.96",
867
      "CodeSystemName": "SNOMED CT",
868
      "Name": "Community Acquired Pneumonia",
869
      "AltCodes": [
870
        {
871
          "Code": "J18.9",
872
          "CodeSystem": "2.16.840.1.113883.6.90",
873
          "CodeSystemName": "ICD-10-CM",
874
          "Name": "Pneumonia"
875
        }
876
      ],
877
      "Value": null,
878
      "Units": null,
879
      "Interpretation": null,
880
      "TargetSite": {
881
        "Code": null,
882
        "CodeSystem": null,
883
        "CodeSystemName": null,
884
        "Name": null,
885
        "AltCodes": []
886
      },
887
      "Status": "active",
888
      "Comments": []
889
    }
890
  ],
891
  "ImmunizationText": "<table width=\"100%\"><thead><tr><th>Vaccine</th><th>Date</th><th>Status</th></tr></thead><tbody><tr><td ID=\"immun2\">Influenza virus vaccine, IM</td><td>May 2012</td><td>Completed</td></tr><tr><td ID=\"immun4\">Tetanus and diphtheria toxoids, IM</td><td>Apr 2012</td><td>Completed</td></tr></tbody></table>",
892
  "Immunizations": [
893
    {
894
      "DateTime": "2012-05-10T04:00:00.000Z",
895
      "Route": {
896
        "Code": "C28161",
897
        "CodeSystem": "2.16.840.1.113883.3.26.1.1",
898
        "CodeSystemName": "National Cancer Institute (NCI) Thesaurus",
899
        "Name": "Intramuscular injection",
900
        "AltCodes": []
901
      },
902
      "Status": null,
903
      "Product": {
904
        "Manufacturer": "Health LS - Immuno Inc.",
905
        "Code": "88",
906
        "CodeSystem": "2.16.840.1.113883.6.59",
907
        "CodeSystemName": "CVX",
908
        "Name": "Influenza virus vaccine",
909
        "AltCodes": [],
910
        "LotNumber": null
911
      },
912
      "Dose": {
913
        "Quantity": "50",
914
        "Units": "mcg"
915
      },
916
      "ReasonNotGiven": null,
917
      "AdministrationHistory": []
918
    },
919
    {
920
      "DateTime": "2012-04-01T04:00:00.000Z",
921
      "Route": {
922
        "Code": "C28161",
923
        "CodeSystem": "2.16.840.1.113883.3.26.1.1",
924
        "CodeSystemName": "National Cancer Institute (NCI) Thesaurus",
925
        "Name": "Intramuscular injection",
926
        "AltCodes": []
927
      },
928
      "Status": null,
929
      "Product": {
930
        "Manufacturer": "Health LS - Immuno Inc.",
931
        "Code": "103",
932
        "CodeSystem": "2.16.840.1.113883.6.59",
933
        "CodeSystemName": "CVX",
934
        "Name": "Tetanus and diphtheria toxoids - preservative free",
935
        "AltCodes": [],
936
        "LotNumber": null
937
      },
938
      "Dose": {
939
        "Quantity": "50",
940
        "Units": "mcg"
941
      },
942
      "ReasonNotGiven": null,
943
      "AdministrationHistory": []
944
    }
945
  ],
946
  "InsurancesText": null,
947
  "Insurances": [
948
    {
949
      "Plan": {
950
        "ID": "31572",
951
        "IDType": "2.16.840.1.113883.4.642.3.520",
952
        "Name": "HMO Deductible Plan",
953
        "Type": null
954
      },
955
      "MemberNumber": null,
956
      "Company": {
957
        "ID": "60054",
958
        "IDType": null,
959
        "Name": "aetna (60054 0131)",
960
        "Address": {
961
          "StreetAddress": "PO Box 14080",
962
          "City": "Lexington",
963
          "State": "KY",
964
          "ZIP": "40512-4079",
965
          "County": "Fayette",
966
          "Country": "US",
967
          "Use": null
968
        },
969
        "PhoneNumber": "+18089541123"
970
      },
971
      "GroupNumber": "847025-024-0009",
972
      "GroupName": "Accelerator Labs",
973
      "EffectiveDate": "2015-01-01",
974
      "ExpirationDate": "2020-12-31",
975
      "PolicyNumber": "9140860055",
976
      "Priority": null,
977
      "AgreementType": null,
978
      "CoverageType": null,
979
      "Insured": {
980
        "Identifiers": [],
981
        "LastName": null,
982
        "MiddleName": null,
983
        "FirstName": null,
984
        "SSN": null,
985
        "Relationship": null,
986
        "DOB": null,
987
        "Sex": null,
988
        "Address": {
989
          "StreetAddress": null,
990
          "City": null,
991
          "State": null,
992
          "ZIP": null,
993
          "County": null,
994
          "Country": null,
995
          "Use": null
996
        }
997
      }
998
    }
999
  ],
1000
  "MedicalEquipmentText": "<table width=\"100%\"><thead><tr><th>Supply/Device</th><th>Date Supplied</th></tr></thead><tbody><tr><td>Automatic implantable cardioverter/defibrillator</td><td>Nov 1999</td></tr><tr><td>Total hip replacement prosthesis</td><td>1998</td></tr><tr><td>Wheelchair</td><td>1999</td></tr></tbody></table>",
1001
  "MedicalEquipment": [
1002
    {
1003
      "Status": "completed",
1004
      "StartDate": "1999-11-01T05:00:00.000Z",
1005
      "Quantity": "2",
1006
      "Comments": [],
1007
      "Product": {
1008
        "Code": "72506001",
1009
        "CodeSystem": "2.16.840.1.113883.6.96",
1010
        "CodeSystemName": "SNOMED CT",
1011
        "Name": "Automatic implantable cardioverter/defibrillator",
1012
        "AltCodes": [],
1013
        "Identifiers": [],
1014
        "DeviceID": null,
1015
        "Issuer": null,
1016
        "SerialNumber": null,
1017
        "DistinctID": null,
1018
        "ManufacturerName": null,
1019
        "LotNumber": null,
1020
        "ManufactureDate": null,
1021
        "ExpirationDate": null,
1022
        "BrandName": null,
1023
        "ModelNumber": null,
1024
        "CatalogNumber": null,
1025
        "Status": {
1026
          "Code": null,
1027
          "CodeSystem": null,
1028
          "CodeSystemName": null,
1029
          "Name": null
1030
        },
1031
        "SafetyObservations": []
1032
      },
1033
      "Procedure": {
1034
        "Code": null,
1035
        "CodeSystem": null,
1036
        "CodeSystemName": null,
1037
        "Name": null,
1038
        "AltCodes": [],
1039
        "TargetSite": {
1040
          "Code": null,
1041
          "CodeSystem": null,
1042
          "CodeSystemName": null,
1043
          "Name": null,
1044
          "AltCodes": []
1045
        }
1046
      }
1047
    },
1048
    {
1049
      "Status": "completed",
1050
      "StartDate": "1998-01-01T05:00:00.000Z",
1051
      "Quantity": null,
1052
      "Comments": [],
1053
      "Product": {
1054
        "Code": "304120007",
1055
        "CodeSystem": "2.16.840.1.113883.6.96",
1056
        "CodeSystemName": "SNOMED CT",
1057
        "Name": "Total hip replacement prosthesis",
1058
        "AltCodes": [],
1059
        "Identifiers": [],
1060
        "DeviceID": null,
1061
        "Issuer": null,
1062
        "SerialNumber": null,
1063
        "DistinctID": null,
1064
        "ManufacturerName": null,
1065
        "LotNumber": null,
1066
        "ManufactureDate": null,
1067
        "ExpirationDate": null,
1068
        "BrandName": null,
1069
        "ModelNumber": null,
1070
        "CatalogNumber": null,
1071
        "Status": {
1072
          "Code": null,
1073
          "CodeSystem": null,
1074
          "CodeSystemName": null,
1075
          "Name": null
1076
        },
1077
        "SafetyObservations": []
1078
      },
1079
      "Procedure": {
1080
        "Code": null,
1081
        "CodeSystem": null,
1082
        "CodeSystemName": null,
1083
        "Name": null,
1084
        "AltCodes": [],
1085
        "TargetSite": {
1086
          "Code": null,
1087
          "CodeSystem": null,
1088
          "CodeSystemName": null,
1089
          "Name": null,
1090
          "AltCodes": []
1091
        }
1092
      }
1093
    },
1094
    {
1095
      "Status": "completed",
1096
      "StartDate": "1999-01-01T05:00:00.000Z",
1097
      "Quantity": null,
1098
      "Comments": [],
1099
      "Product": {
1100
        "Code": "58938008",
1101
        "CodeSystem": "2.16.840.1.113883.6.96",
1102
        "CodeSystemName": "SNOMED CT",
1103
        "Name": "Wheelchair",
1104
        "AltCodes": [],
1105
        "Identifiers": [],
1106
        "DeviceID": null,
1107
        "Issuer": null,
1108
        "SerialNumber": null,
1109
        "DistinctID": null,
1110
        "ManufacturerName": null,
1111
        "LotNumber": null,
1112
        "ManufactureDate": null,
1113
        "ExpirationDate": null,
1114
        "BrandName": null,
1115
        "ModelNumber": null,
1116
        "CatalogNumber": null,
1117
        "Status": {
1118
          "Code": null,
1119
          "CodeSystem": null,
1120
          "CodeSystemName": null,
1121
          "Name": null
1122
        },
1123
        "SafetyObservations": []
1124
      },
1125
      "Procedure": {
1126
        "Code": null,
1127
        "CodeSystem": null,
1128
        "CodeSystemName": null,
1129
        "Name": null,
1130
        "AltCodes": [],
1131
        "TargetSite": {
1132
          "Code": null,
1133
          "CodeSystem": null,
1134
          "CodeSystemName": null,
1135
          "Name": null,
1136
          "AltCodes": []
1137
        }
1138
      }
1139
    }
1140
  ],
1141
  "MedicationsText": "<table width=\"100%\"><thead><tr><th>Medication</th><th>Directions</th><th>Start Date</th><th>Status</th><th>Indications</th><th>Fill Instructions</th></tr></thead><tbody><tr><td ID=\"Med1\">Albuterol 0.09 MG/ACTUAT inhalant solution</td><td>0.09 MG/ACTUAT inhalant solution, 2 puffs once</td><td>20120806</td><td>Active</td><td>Pneumonia (233604007 SNOMED CT)</td><td ID=\"FillIns\">Generic Substitition Allowed</td></tr></tbody></table>",
1142
  "Medications": [
1143
    {
1144
      "Prescription": false,
1145
      "FreeTextSig": null,
1146
      "Dose": {
1147
        "Quantity": "4",
1148
        "Units": "mg"
1149
      },
1150
      "Rate": {
1151
        "Quantity": null,
1152
        "Units": null
1153
      },
1154
      "Route": {
1155
        "Code": "C38288",
1156
        "CodeSystem": "2.16.840.1.113883.3.26.1.1",
1157
        "CodeSystemName": "NCI Thesaurus",
1158
        "Name": "Oral",
1159
        "AltCodes": []
1160
      },
1161
      "Status": null,
1162
      "StartDate": "2013-11-11T05:00:00.000Z",
1163
      "EndDate": null,
1164
      "Frequency": {
1165
        "Period": "8",
1166
        "PeriodMax": null,
1167
        "Unit": "h",
1168
        "EventCode": null,
1169
        "InstitutionSpecified": null
1170
      },
1171
      "NumberOfRefillsRemaining": null,
1172
      "TotalRefills": null,
1173
      "LastRefillDate": null,
1174
      "IsPRN": null,
1175
      "Product": {
1176
        "Code": "104894",
1177
        "CodeSystem": "2.16.840.1.113883.6.88",
1178
        "CodeSystemName": "RxNorm",
1179
        "Name": "Ondansetron 4 Mg Po Tbdp",
1180
        "AltCodes": [
1181
          {
1182
            "Code": "0378-7732-93",
1183
            "CodeSystem": "2.16.840.1.113883.6.69",
1184
            "CodeSystemName": "NDC",
1185
            "Name": "Ondansetron 4 Mg Po Tbdp"
1186
          },
1187
          {
1188
            "Code": "64695",
1189
            "CodeSystem": "2.16.840.1.113883.6.253",
1190
            "CodeSystemName": "MDDID",
1191
            "Name": "Ondansetron 4 Mg Po Tbdp"
1192
          },
1193
          {
1194
            "Code": "50250065007220",
1195
            "CodeSystem": "2.16.840.1.113883.6.68",
1196
            "CodeSystemName": "Medispan GPI",
1197
            "Name": "Ondansetron 4 Mg Po Tbdp"
1198
          },
1199
          {
1200
            "Code": "64695",
1201
            "CodeSystem": "2.16.840.1.113883.6.162",
1202
            "CodeSystemName": "Medispan",
1203
            "Name": "Ondansetron 4 Mg Po Tbdp"
1204
          }
1205
        ]
1206
      },
1207
      "Indications": [],
1208
      "SupplyOrder": {
1209
        "StartDate": null,
1210
        "EndDate": null,
1211
        "Quantity": null,
1212
        "Units": null,
1213
        "NumberOfRefillsRemaining": null
1214
      },
1215
      "AdministrationHistory": []
1216
    },
1217
    {
1218
      "Prescription": false,
1219
      "FreeTextSig": null,
1220
      "Dose": {
1221
        "Quantity": "0.09",
1222
        "Units": "mg/actuat"
1223
      },
1224
      "Rate": {
1225
        "Quantity": "90",
1226
        "Units": "ml/min"
1227
      },
1228
      "Route": {
1229
        "Code": "C38216",
1230
        "CodeSystem": "2.16.840.1.113883.3.26.1.1",
1231
        "CodeSystemName": "NCI Thesaurus",
1232
        "Name": "RESPIRATORY (INHALATION)",
1233
        "AltCodes": []
1234
      },
1235
      "Status": null,
1236
      "StartDate": "2012-08-06T04:00:00.000Z",
1237
      "EndDate": "2012-08-13T04:00:00.000Z",
1238
      "Frequency": {
1239
        "Period": "12",
1240
        "PeriodMax": null,
1241
        "Unit": "h",
1242
        "EventCode": null,
1243
        "InstitutionSpecified": null
1244
      },
1245
      "NumberOfRefillsRemaining": null,
1246
      "TotalRefills": null,
1247
      "LastRefillDate": null,
1248
      "IsPRN": true,
1249
      "Product": {
1250
        "Code": "573621",
1251
        "CodeSystem": "2.16.840.1.113883.6.88",
1252
        "CodeSystemName": "RxNorm",
1253
        "Name": "Albuterol 0.09 MG/ACTUAT inhalant solution",
1254
        "AltCodes": []
1255
      },
1256
      "Indications": [
1257
        {
1258
          "Code": "422587007",
1259
          "CodeSystem": "2.16.840.1.113883.6.96",
1260
          "CodeSystemName": "SNOMED CT",
1261
          "Name": "Nausea",
1262
          "AltCodes": []
1263
        }
1264
      ],
1265
      "SupplyOrder": {
1266
        "StartDate": null,
1267
        "EndDate": null,
1268
        "Quantity": null,
1269
        "Units": null,
1270
        "NumberOfRefillsRemaining": null
1271
      },
1272
      "AdministrationHistory": []
1273
    }
1274
  ],
1275
  "PlanOfCareText": "<table width=\"100%\"><thead><tr><th>Planned Activity</th><th>Planned Date</th></tr></thead><tbody><tr><td>Consultation with Dr George Potomac for Asthma</td><td>20120820</td></tr><tr><td>Chest X-ray</td><td>20120826</td></tr><tr><td>Sputum Culture</td><td>20120820</td></tr></tbody></table>",
1276
  "PlanOfCare": {
1277
    "Orders": [
1278
      {
1279
        "Code": "624-7",
1280
        "CodeSystem": "2.16.840.1.113883.6.1",
1281
        "CodeSystemName": null,
1282
        "Name": "Sputum Culture",
1283
        "AltCodes": [],
1284
        "Status": "Request",
1285
        "DateTime": "2012-08-20T05:00:00.000Z"
1286
      }
1287
    ],
1288
    "Procedures": [
1289
      {
1290
        "Code": "168731009",
1291
        "CodeSystem": "2.16.840.1.113883.6.96",
1292
        "CodeSystemName": "SNOMED-CT",
1293
        "Name": "Chest X-Ray",
1294
        "AltCodes": [],
1295
        "Status": "Request",
1296
        "DateTime": "2012-08-26T05:00:00.000Z"
1297
      }
1298
    ],
1299
    "Encounters": [
1300
      {
1301
        "Code": "99241",
1302
        "CodeSystem": "2.16.840.1.113883.6.12",
1303
        "CodeSystemName": "CPT",
1304
        "Name": "Office consultation - 15 minutes",
1305
        "AltCodes": [],
1306
        "Identifiers": [],
1307
        "Status": "Intent",
1308
        "DateTime": "2012-08-20T05:00:00.000Z"
1309
      }
1310
    ],
1311
    "MedicationAdministration": [
1312
      {
1313
        "Status": "Intent",
1314
        "Dose": {
1315
          "Quantity": "81",
1316
          "Units": "milliGRAM(s)"
1317
        },
1318
        "Rate": {
1319
          "Quantity": null,
1320
          "Units": null
1321
        },
1322
        "Route": {
1323
          "Code": "C38288",
1324
          "CodeSystem": "2.16.840.1.113883.3.26.1.1",
1325
          "CodeSystemName": "NCI Thesaurus",
1326
          "Name": "ORAL",
1327
          "AltCodes": []
1328
        },
1329
        "StartDate": "2012-10-02T05:00:00.000Z",
1330
        "EndDate": "2012-10-31T04:59:00.000Z",
1331
        "Frequency": {
1332
          "Period": null,
1333
          "Unit": null
1334
        },
1335
        "Product": {
1336
          "Code": "1191",
1337
          "CodeSystem": "2.16.840.1.113883.6.88",
1338
          "CodeSystemName": "RxNorm",
1339
          "Name": "aspirin",
1340
          "AltCodes": []
1341
        }
1342
      }
1343
    ],
1344
    "Supplies": [],
1345
    "Services": [
1346
      {
1347
        "Code": "427519008",
1348
        "CodeSystem": "2.16.840.1.113883.11.20.9.34",
1349
        "CodeSystemName": "patientEducationType",
1350
        "Name": "Caregiver",
1351
        "AltCodes": [],
1352
        "Status": "Intent",
1353
        "DateTime": null
1354
      }
1355
    ]
1356
  },
1357
  "ProblemsText": "<list><item ID=\"problem1\">Pneumonia : Status - Resolved</item><item ID=\"problem2\">Asthma : Status - Active</item></list>",
1358
  "Problems": [
1359
    {
1360
      "StartDate": "2012-08-06T04:00:00.000Z",
1361
      "EndDate": "2012-08-06T04:00:00.000Z",
1362
      "Code": "233604007",
1363
      "CodeSystem": "2.16.840.1.113883.6.96",
1364
      "CodeSystemName": "SNOMED CT",
1365
      "Name": "Pneumonia",
1366
      "AltCodes": [
1367
        {
1368
          "Code": "J18.9",
1369
          "CodeSystem": "2.16.840.1.113883.6.90",
1370
          "CodeSystemName": "ICD-10-CM",
1371
          "Name": "Pneumonia"
1372
        },
1373
        {
1374
          "Code": "486",
1375
          "CodeSystem": "2.16.840.1.113883.6.103",
1376
          "CodeSystemName": "ICD-9-CM",
1377
          "Name": "Pneumonia"
1378
        }
1379
      ],
1380
      "Category": {
1381
        "Code": "409586006",
1382
        "CodeSystem": "2.16.840.1.113883.6.96",
1383
        "CodeSystemName": "SNOMED CT",
1384
        "Name": "Complaint",
1385
        "AltCodes": []
1386
      },
1387
      "Status": {
1388
        "Code": "413322009",
1389
        "CodeSystem": "2.16.840.1.113883.6.96",
1390
        "CodeSystemName": "SNOMED CT",
1391
        "Name": "Resolved"
1392
      },
1393
      "Comment": null,
1394
      "Comments": [],
1395
      "HealthStatus": {
1396
        "Code": "162467007",
1397
        "CodeSystem": "2.16.840.1.113883.6.96",
1398
        "CodeSystemName": "SNOMED CT",
1399
        "Name": "Symptom Free",
1400
        "AltCodes": []
1401
      }
1402
    },
1403
    {
1404
      "StartDate": "2007-10-17T04:00:00.000Z",
1405
      "EndDate": "2012-08-06T04:00:00.000Z",
1406
      "Code": "195967001",
1407
      "CodeSystem": "2.16.840.1.113883.6.96",
1408
      "CodeSystemName": "SNOMED CT",
1409
      "Name": "Asthma",
1410
      "AltCodes": [
1411
        {
1412
          "Code": "J45.909",
1413
          "CodeSystem": "2.16.840.1.113883.6.90",
1414
          "CodeSystemName": "ICD-10-CM",
1415
          "Name": "Asthma"
1416
        },
1417
        {
1418
          "Code": "493.90",
1419
          "CodeSystem": "2.16.840.1.113883.6.103",
1420
          "CodeSystemName": "ICD-9-CM",
1421
          "Name": "Asthma"
1422
        }
1423
      ],
1424
      "Category": {
1425
        "Code": "409586006",
1426
        "CodeSystem": "2.16.840.1.113883.6.96",
1427
        "CodeSystemName": "SNOMED CT",
1428
        "Name": "Complaint",
1429
        "AltCodes": []
1430
      },
1431
      "Status": {
1432
        "Code": "55561003",
1433
        "CodeSystem": "2.16.840.1.113883.6.96",
1434
        "CodeSystemName": "SNOMED CT",
1435
        "Name": "Active"
1436
      },
1437
      "Comment": null,
1438
      "Comments": [],
1439
      "HealthStatus": {
1440
        "Code": "162467007",
1441
        "CodeSystem": "2.16.840.1.113883.6.96",
1442
        "CodeSystemName": "SNOMED CT",
1443
        "Name": "Symptom Free",
1444
        "AltCodes": []
1445
      }
1446
    }
1447
  ],
1448
  "ProceduresText": "<table width=\"100%\"><thead><tr><th>Procedure</th><th>Date</th></tr></thead><tbody><tr><td ID=\"Proc2\">Chest X-Ray</td><td>8/7/2012</td></tr></tbody></table>",
1449
  "Procedures": {
1450
    "Observations": [
1451
      {
1452
        "Code": "123456",
1453
        "CodeSystem": "2.16.840.1.113883.6.96",
1454
        "CodeSystemName": "SNOMED-CT",
1455
        "Name": "Fake observation",
1456
        "AltCodes": [],
1457
        "DateTime": "2012-08-07",
1458
        "Status": "active",
1459
        "TargetSite": {
1460
          "Code": "302539009",
1461
          "CodeSystem": "2.16.840.1.113883.6.96",
1462
          "CodeSystemName": "SNOMED-CT",
1463
          "Name": "Entire hand (body structure)",
1464
          "AltCodes": []
1465
        },
1466
        "Comments": []
1467
      }
1468
    ],
1469
    "Procedures": [
1470
      {
1471
        "Code": "168731009",
1472
        "CodeSystem": "2.16.840.1.113883.6.96",
1473
        "CodeSystemName": "SNOMED-CT",
1474
        "Name": "Chest X-Ray",
1475
        "AltCodes": [],
1476
        "DateTime": "2012-08-07",
1477
        "Status": "completed",
1478
        "TargetSite": {
1479
          "Code": "181608004",
1480
          "CodeSystem": "2.16.840.1.113883.6.96",
1481
          "CodeSystemName": "SNOMED-CT",
1482
          "Name": "Entire chest wall (body structure)",
1483
          "AltCodes": []
1484
        },
1485
        "Comments": []
1486
      }
1487
    ],
1488
    "Services": [
1489
      {
1490
        "Code": "123456",
1491
        "CodeSystem": "2.16.840.1.113883.6.96",
1492
        "CodeSystemName": "SNOMED-CT",
1493
        "Name": "Fake action",
1494
        "AltCodes": [],
1495
        "DateTime": "2012-08-07",
1496
        "Status": "aborted",
1497
        "Comments": []
1498
      }
1499
    ]
1500
  },
1501
  "ResolvedProblemsText": "<list><item ID=\"problem1\">Tobacco abuse : Status - Resolved</item></list>",
1502
  "ResolvedProblems": [
1503
    {
1504
      "StartDate": "2012-08-06T04:00:00.000Z",
1505
      "EndDate": "2012-08-06T04:00:00.000Z",
1506
      "Code": "110483000",
1507
      "CodeSystem": "2.16.840.1.113883.6.96",
1508
      "CodeSystemName": "SNOMED CT",
1509
      "Name": "Tobacco abuse",
1510
      "AltCodes": [
1511
        {
1512
          "Code": "Z72.0",
1513
          "CodeSystem": "2.16.840.1.113883.6.90",
1514
          "CodeSystemName": "ICD-10-CM",
1515
          "Name": "Tobacco abuse"
1516
        },
1517
        {
1518
          "Code": "305.1",
1519
          "CodeSystem": "2.16.840.1.113883.6.103",
1520
          "CodeSystemName": "ICD-9-CM",
1521
          "Name": "Tobacco abuse"
1522
        },
1523
        {
1524
          "Code": "55885",
1525
          "CodeSystem": "2.16.840.1.113883.3.247.1.1",
1526
          "CodeSystemName": "Intelligent Medical Objects ProblemIT",
1527
          "Name": "Tobacco abuse"
1528
        }
1529
      ],
1530
      "Category": {
1531
        "Code": "64572001",
1532
        "CodeSystem": "2.16.840.1.113883.6.96",
1533
        "CodeSystemName": "SNOMED CT",
1534
        "Name": "Tobacco abuse",
1535
        "AltCodes": [
1536
          {
1537
            "Code": "75323-6",
1538
            "CodeSystem": "2.16.840.1.113883.6.1",
1539
            "CodeSystemName": "LOINC",
1540
            "Name": "Tobacco abuse"
1541
          }
1542
        ]
1543
      },
1544
      "Status": {
1545
        "Code": "413322009",
1546
        "CodeSystem": "2.16.840.1.113883.6.96",
1547
        "CodeSystemName": "SNOMED CT",
1548
        "Name": "Resolved"
1549
      },
1550
      "Comment": null,
1551
      "Comments": []
1552
    }
1553
  ],
1554
  "ResultText": "<table><tbody><tr><td colspan=\"2\">LABORATORY INFORMATION</td></tr><tr><td colspan=\"2\">Chemistries and drug levels</td></tr><tr><td ID=\"result1\">HGB (M 13-18 g/dl; F 12-16 g/dl)</td><td>13.2</td></tr><tr><td ID=\"result2\">WBC (4.3-10.8 10+3/ul)</td><td>6.7</td></tr><tr><td ID=\"result3\">PLT (135-145 meq/l)</td><td>123 (L)</td></tr></tbody></table>",
1555
  "Results": [
1556
    {
1557
      "Code": "43789009",
1558
      "CodeSystem": "2.16.840.1.113883.6.96",
1559
      "CodeSystemName": "SNOMED CT",
1560
      "Name": "CBC WO DIFFERENTIAL",
1561
      "AltCodes": [],
1562
      "Encounter": {
1563
        "Identifiers": [],
1564
        "Status": null,
1565
        "Type": {
1566
          "Code": null,
1567
          "CodeSystem": null,
1568
          "CodeSystemName": null,
1569
          "Name": null,
1570
          "AltCodes": []
1571
        },
1572
        "DateTime": null,
1573
        "EndDateTime": null
1574
      },
1575
      "Status": "Final",
1576
      "Producer": {
1577
        "ID": "RL001",
1578
        "Name": "Redox Lab WI",
1579
        "IDType": null,
1580
        "Address": {
1581
          "StreetAddress": "111 W. Fairchild",
1582
          "City": "Madison",
1583
          "State": "WI",
1584
          "ZIP": "53703",
1585
          "County": "Dane",
1586
          "Country": "USA",
1587
          "Use": null
1588
        }
1589
      },
1590
      "Specimen": {
1591
        "CollectionDateTime": "2012-08-10T14:00:00.000Z",
1592
        "Identifiers": [
1593
          "1.2.840.113840.5^BL-201201-01"
1594
        ],
1595
        "Source": {
1596
          "Code": "420135007",
1597
          "CodeSystem": "2.16.840.1.113883.6.96",
1598
          "CodeSystemName": "SNOMED CT",
1599
          "Name": "Blood, whole"
1600
        },
1601
        "TargetSite": {
1602
          "Code": "LA",
1603
          "CodeSystem": "2.16.840.1.113883.18.81",
1604
          "CodeSystemName": "Body Site",
1605
          "Name": "Left Arm"
1606
        }
1607
      },
1608
      "Observations": [
1609
        {
1610
          "Code": "30313-1",
1611
          "CodeSystem": "2.16.840.1.113883.6.1",
1612
          "CodeSystemName": "LOINC",
1613
          "Name": "HGB",
1614
          "AltCodes": [],
1615
          "Status": "Final",
1616
          "Interpretation": "Normal",
1617
          "DateTime": "2012-08-10T14:00:00.000Z",
1618
          "CodedValue": {
1619
            "Code": null,
1620
            "CodeSystem": null,
1621
            "CodeSystemName": null,
1622
            "Name": null,
1623
            "AltCodes": []
1624
          },
1625
          "Value": "10.2",
1626
          "ValueType": "PhysicalQuantity",
1627
          "FileType": null,
1628
          "Units": "g/dl",
1629
          "ReferenceRange": {
1630
            "Low": null,
1631
            "High": null,
1632
            "Text": null
1633
          },
1634
          "Comments": []
1635
        },
1636
        {
1637
          "Code": "33765-9",
1638
          "CodeSystem": "2.16.840.1.113883.6.1",
1639
          "CodeSystemName": "LOINC",
1640
          "Name": "WBC",
1641
          "AltCodes": [],
1642
          "Status": "Final",
1643
          "Interpretation": "Normal",
1644
          "DateTime": "2012-08-10T14:00:00.000Z",
1645
          "CodedValue": {
1646
            "Code": null,
1647
            "CodeSystem": null,
1648
            "CodeSystemName": null,
1649
            "Name": null,
1650
            "AltCodes": []
1651
          },
1652
          "Value": "12.3",
1653
          "ValueType": "PhysicalQuantity",
1654
          "FileType": null,
1655
          "Units": "10+3/ul",
1656
          "ReferenceRange": {
1657
            "Low": null,
1658
            "High": null,
1659
            "Text": null
1660
          },
1661
          "Comments": []
1662
        },
1663
        {
1664
          "Code": "26515-7",
1665
          "CodeSystem": "2.16.840.1.113883.6.1",
1666
          "CodeSystemName": "LOINC",
1667
          "Name": "PLT",
1668
          "AltCodes": [],
1669
          "Status": "Final",
1670
          "Interpretation": "Low",
1671
          "DateTime": "2012-08-10T14:00:00.000Z",
1672
          "CodedValue": {
1673
            "Code": null,
1674
            "CodeSystem": null,
1675
            "CodeSystemName": null,
1676
            "Name": null,
1677
            "AltCodes": []
1678
          },
1679
          "Value": "123",
1680
          "ValueType": "PhysicalQuantity",
1681
          "FileType": null,
1682
          "Units": "10+3/ul",
1683
          "ReferenceRange": {
1684
            "Low": null,
1685
            "High": null,
1686
            "Text": null
1687
          },
1688
          "Comments": []
1689
        }
1690
      ]
1691
    },
1692
    {
1693
      "Code": "624-7",
1694
      "CodeSystem": "2.16.840.1.113883.6.1",
1695
      "CodeSystemName": "LOINC",
1696
      "Name": "Sputum Culture",
1697
      "AltCodes": [],
1698
      "Encounter": {
1699
        "Identifiers": [],
1700
        "Status": null,
1701
        "Type": {
1702
          "Code": null,
1703
          "CodeSystem": null,
1704
          "CodeSystemName": null,
1705
          "Name": null,
1706
          "AltCodes": []
1707
        },
1708
        "DateTime": null,
1709
        "EndDateTime": null
1710
      },
1711
      "Status": "In Progress",
1712
      "Producer": {
1713
        "ID": "RL001",
1714
        "Name": "Redox Lab WI",
1715
        "IDType": null,
1716
        "Address": {
1717
          "StreetAddress": "111 W. Fairchild",
1718
          "City": "Madison",
1719
          "State": "WI",
1720
          "ZIP": "53703",
1721
          "County": "Dane",
1722
          "Country": "USA",
1723
          "Use": null
1724
        }
1725
      },
1726
      "Specimen": {
1727
        "CollectionDateTime": null,
1728
        "Identifiers": [],
1729
        "Source": {
1730
          "Code": null,
1731
          "CodeSystem": null,
1732
          "CodeSystemName": null,
1733
          "Name": null
1734
        },
1735
        "TargetSite": {
1736
          "Code": null,
1737
          "CodeSystem": null,
1738
          "CodeSystemName": null,
1739
          "Name": null
1740
        }
1741
      },
1742
      "Observations": [
1743
        {
1744
          "Code": "86243-3",
1745
          "CodeSystem": "2.16.840.1.113883.6.1",
1746
          "CodeSystemName": "LOINC",
1747
          "Name": "Color of Sputum",
1748
          "AltCodes": [],
1749
          "Status": "Final",
1750
          "Interpretation": null,
1751
          "DateTime": "2012-08-10T14:00:00.000Z",
1752
          "CodedValue": {
1753
            "Code": "54662009",
1754
            "CodeSystem": "2.16.840.1.113883.6.96",
1755
            "CodeSystemName": "SNOMED CT",
1756
            "Name": "Green",
1757
            "AltCodes": []
1758
          },
1759
          "Value": "Green",
1760
          "ValueType": "Code",
1761
          "FileType": null,
1762
          "Units": null,
1763
          "ReferenceRange": {
1764
            "Low": null,
1765
            "High": null,
1766
            "Text": null
1767
          },
1768
          "Comments": []
1769
        }
1770
      ]
1771
    }
1772
  ],
1773
  "SocialHistoryText": "<table width=\"100%\"><thead><tr><th>Social History Element</th><th>Description</th><th>Effective Dates</th></tr></thead><tbody><tr><td ID=\"soc1\">smoking</td><td>Former Smoker (1 pack per day</td><td>20050501 to 20110227</td></tr><tr><td ID=\"soc2\">smoking</td><td>Current Everyday Smoker 2 packs per day</td><td>20110227 - today</td></tr></tbody></table>",
1774
  "SocialHistory": {
1775
    "Observations": [
1776
      {
1777
        "Code": "160573003",
1778
        "CodeSystem": "2.16.840.1.113883.6.96",
1779
        "CodeSystemName": "SNOMED CT",
1780
        "Name": "Alcohol Consumption",
1781
        "AltCodes": [],
1782
        "Value": {
1783
          "Code": null,
1784
          "CodeSystem": null,
1785
          "CodeSystemName": null,
1786
          "Name": null,
1787
          "AltCodes": []
1788
        },
1789
        "ValueText": "1",
1790
        "Units": "/d",
1791
        "StartDate": "1990-05-01T04:00:00.000Z",
1792
        "EndDate": null,
1793
        "Comments": []
1794
      }
1795
    ],
1796
    "Pregnancy": [],
1797
    "TobaccoUse": [
1798
      {
1799
        "Code": "8517006",
1800
        "CodeSystem": "2.16.840.1.113883.6.96",
1801
        "CodeSystemName": "SNOMED CT",
1802
        "Name": "Former smoker",
1803
        "AltCodes": [],
1804
        "IsSmokingStatus": true,
1805
        "StartDate": "2015-06-03T09:35:00.000Z",
1806
        "EndDate": null,
1807
        "Comments": []
1808
      },
1809
      {
1810
        "Code": "65568007",
1811
        "CodeSystem": "2.16.840.1.113883.6.96",
1812
        "CodeSystemName": "SNOMED CT",
1813
        "Name": "Cigarette smoker",
1814
        "AltCodes": [],
1815
        "IsSmokingStatus": false,
1816
        "StartDate": "2005-05-01",
1817
        "EndDate": "2008-09-01",
1818
        "Comments": []
1819
      }
1820
    ]
1821
  },
1822
  "VitalSignsText": "<table width=\"100%\"><thead><tr><th align=\"right\">Date / Time: </th><th>Nov 1, 2011</th><th>August 6, 2012</th></tr></thead><tbody><tr><th align=\"left\">Height</th><td ID=\"vit1\">69 inches</td><td ID=\"vit2\">69 inches</td></tr><tr><th align=\"left\">Weight</th><td ID=\"vit3\">189 lbs</td><td ID=\"vit4\">194 lbs</td></tr><tr><th align=\"left\">Blood Pressure</th><td ID=\"vit5\">132/86 mmHg</td><td ID=\"vit6\">145/88 mmHg</td></tr></tbody></table>",
1823
  "VitalSigns": [
1824
    {
1825
      "DateTime": "1999-11-14T00:00:00.000Z",
1826
      "Observations": [
1827
        {
1828
          "Code": "8302-2",
1829
          "CodeSystem": "2.16.840.1.113883.6.1",
1830
          "CodeSystemName": "LOINC",
1831
          "Name": "Height",
1832
          "AltCodes": [],
1833
          "Status": "completed",
1834
          "Interpretation": "Normal",
1835
          "DateTime": "1999-11-14T00:00:00.000Z",
1836
          "Value": "177",
1837
          "Units": "cm",
1838
          "TargetSite": {
1839
            "Code": null,
1840
            "CodeSystem": null,
1841
            "CodeSystemName": null,
1842
            "Name": null,
1843
            "AltCodes": []
1844
          },
1845
          "Comments": []
1846
        },
1847
        {
1848
          "Code": "3141-9",
1849
          "CodeSystem": "2.16.840.1.113883.6.1",
1850
          "CodeSystemName": "LOINC",
1851
          "Name": "Patient Body Weight - Measured",
1852
          "AltCodes": [],
1853
          "Status": "completed",
1854
          "Interpretation": "Normal",
1855
          "DateTime": "1999-11-14T00:00:00.000Z",
1856
          "Value": "86",
1857
          "Units": "kg",
1858
          "TargetSite": {
1859
            "Code": null,
1860
            "CodeSystem": null,
1861
            "CodeSystemName": null,
1862
            "Name": null,
1863
            "AltCodes": []
1864
          },
1865
          "Comments": []
1866
        },
1867
        {
1868
          "Code": "8480-6",
1869
          "CodeSystem": "2.16.840.1.113883.6.1",
1870
          "CodeSystemName": "LOINC",
1871
          "Name": "Intravascular Systolic",
1872
          "AltCodes": [],
1873
          "Status": "completed",
1874
          "Interpretation": "Normal",
1875
          "DateTime": "1999-11-14T00:00:00.000Z",
1876
          "Value": "132",
1877
          "Units": "mm[Hg]",
1878
          "TargetSite": {
1879
            "Code": "368208006",
1880
            "CodeSystem": "2.16.840.1.113883.6.96",
1881
            "CodeSystemName": "SNOMED CT",
1882
            "Name": "Left upper arm structure",
1883
            "AltCodes": []
1884
          },
1885
          "Comments": []
1886
        }
1887
      ]
1888
    },
1889
    {
1890
      "DateTime": "2000-04-07T00:00:00.000Z",
1891
      "Observations": [
1892
        {
1893
          "Code": "8302-2",
1894
          "CodeSystem": "2.16.840.1.113883.6.1",
1895
          "CodeSystemName": "LOINC",
1896
          "Name": "Height",
1897
          "AltCodes": [],
1898
          "Status": "completed",
1899
          "Interpretation": "Normal",
1900
          "DateTime": "2000-04-07T00:00:00.000Z",
1901
          "Value": "177",
1902
          "Units": "cm",
1903
          "TargetSite": {
1904
            "Code": null,
1905
            "CodeSystem": null,
1906
            "CodeSystemName": null,
1907
            "Name": null,
1908
            "AltCodes": []
1909
          },
1910
          "Comments": []
1911
        },
1912
        {
1913
          "Code": "3141-9",
1914
          "CodeSystem": "2.16.840.1.113883.6.1",
1915
          "CodeSystemName": "LOINC",
1916
          "Name": "Patient Body Weight - Measured",
1917
          "AltCodes": [],
1918
          "Status": "completed",
1919
          "Interpretation": "Normal",
1920
          "DateTime": "2000-04-07T00:00:00.000Z",
1921
          "Value": "88",
1922
          "Units": "kg",
1923
          "TargetSite": {
1924
            "Code": null,
1925
            "CodeSystem": null,
1926
            "CodeSystemName": null,
1927
            "Name": null,
1928
            "AltCodes": []
1929
          },
1930
          "Comments": []
1931
        },
1932
        {
1933
          "Code": "8480-6",
1934
          "CodeSystem": "2.16.840.1.113883.6.1",
1935
          "CodeSystemName": "LOINC",
1936
          "Name": "Intravascular Systolic",
1937
          "AltCodes": [],
1938
          "Status": "completed",
1939
          "Interpretation": "Normal",
1940
          "DateTime": "2000-04-07T00:00:00.000Z",
1941
          "Value": "145",
1942
          "Units": "mm[Hg]",
1943
          "TargetSite": {
1944
            "Code": "368208006",
1945
            "CodeSystem": "2.16.840.1.113883.6.96",
1946
            "CodeSystemName": "SNOMED CT",
1947
            "Name": "Left upper arm structure",
1948
            "AltCodes": []
1949
          },
1950
          "Comments": []
1951
        }
1952
      ]
1953
    }
1954
  ]
1955
}