Home
API reference
Redox Data Models
Clinical Summary
VisitPush

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.

VisitPush

Send a visit summary to your connection. This document is typically a description of the patient's state and an encounter-level description of care. Include the Header section with all its required fields. Populate other relevant sections in the request body.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Clinical Summary

    • EventType
      required, string
      Reliable

      VisitPush

    • 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.

    • DirectAddressFrom
      null, null
      Possible

      The sender's Direct address, if one or both sides are using Direct messaging.

    • DirectAddressTo
      null, null
      Possible

      The recipient's Direct address, if one or both sides are using Direct messaging.

    • 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

      • Visit
        object

        If the document is tied to a visit, this contains information about the encompassing encounter.

        • StartDateTime
          string, null
          Probable

          The start date/time of the visit.
          ISO 8601 Format

        • EndDateTime
          string, null
          Probable

          The end date/time of the visit.
          ISO 8601 Format

        • Reason
          string, null
          Possible

          The reason for visit.
          The Reason for Visit is rarely found in the header. Instead, look to the ReasonForVisitText and related fields.

        • VisitNumber
          string, null
          Reliable

          ID for the patient visit/encounter.

        • Type
          object
          • Code
            string, null
            Probable

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

          • 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 visit (office visit, hospital, etc)

          • AltCodes
            Array of object

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

            • Code
              string, null
              Possible

              A code describing the type of visit (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 visit (office visit, hospital, etc)

        • Location
          object

          The location of the visit. Note - more precise information may be available via an extension.

          • 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

        • 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.

    • 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

  • AdmissionDiagnosisText
    string, null
    Possible

    Free text of the clinician's conclusions at time of Admission.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • AdmissionDiagnosis
    Array of object

    An array of diagnoses

    • StartDate
      string, null
      Possible

      The onset date of the diagnosis.
      ISO 8601 Format

    • EndDate
      string, null
      Possible

      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
      Possible

      A code describing the diagnosis.
      ICD9, ICD10, HCPC, CPT, 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 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.

  • 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.

  • AssessmentText
    string, null
    Probable

    Free text of the clinician's conclusions and working assumptions that will guide treatment of the patient.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • Assessment
    object
    • Diagnoses
      Array of object

      An array of diagnoses

      • Value
        string, null
        Probable

        The diagnosis as free text

      • DateTime
        string, null
        Probable

        When the diagnosis was recorded.
        ISO 8601 Format

      • IsNegativeIndicator
        boolean, null
        Probable

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

      • Codes
        Array of object
        • 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

      • Comments
        Array of object

        Free text comments about the diagnosis.

        • 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

  • ChiefComplaintText
    string, null
    Reliable

    Free text chief complaint with any documented exposition.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • DischargeDiagnosisText
    string, null
    Possible

    Free text of the clinician's conclusions at time of Discharge.
    When sent via Redox API, this can ONLY be pushed as plain text without any markup.

  • DischargeDiagnosis
    Array of object

    An array of diagnoses

    • StartDate
      string, null
      Possible

      The onset date of the diagnosis.
      ISO 8601 Format

    • EndDate
      string, null
      Possible

      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
      Possible

      A code describing the diagnosis.
      ICD9, ICD10, HCPC, CPT, 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 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.

  • DischargeMedicationsText
    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.

  • DischargeMedications
    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

  • 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