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.
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
- Metarequired, object
- DataModelrequired, stringReliable
Clinical Summary
- EventTyperequired, stringReliable
PatientQueryResponse
- EventDateTimestring, nullReliable
Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format - Testboolean, nullReliable
Indicates whether the request is a test or not.
- Sourceobject
Contains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox- IDstring, nullReliable
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 - Namestring, nullReliable
Displays the name of the system initiating the message.
- DestinationsArray 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.- IDstring, nullReliable
Identifies the endpoint that the request is directed to.
UUID - Namestring, nullReliable
Displays the name of the endpoint that the request is directed to.
- LogsArray of object
Contains the log identifier(s) for the request.
- IDstring, nullReliable
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 - AttemptIDstring, nullReliable
Identifies the request log attempt value, which is useful when retries are possible.
UUID
- FacilityCodestring, nullPossible
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.
- Headerobject
- Documentobject
An object containing metadata about the document being pushed to the destination.
- Authorobject
- IDstring, nullReliable
ID of the Provider responsible for the document.
This ID is often required for Inpatient Visits. - IDTypestring, nullReliable
ID type of the ID for the Provider responsible for the document
- FirstNamestring, nullPossible
First name of the Provider responsible for the document
- LastNamestring, nullPossible
Last name of the Provider responsible for the document
- CredentialsArray of string
List of credentials for the Provider responsible for the document.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Typestring, nullReliableValue Set
The type of Provider responsible for the document
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- IDstring, nullReliable
Your application's ID for the document
- SetIDstring, nullPossible
An ID for the document that is common across all document revisions.
WhenSetIDis provided,VersionNumberis required. - VersionNumberstring, nullPossible
An integer version number for this revision of the document.
WhenSetIDis provided,VersionNumberis required. Used when superseding or modifying a prior version of the same document. For example, this document might beVersionNumber2, and it has aRelatesTo[].VersionNumber1, the prior version with the sameRelatesTo[].SetID. - RelatesToArray of object
The identifiers for other documents related to this document, such as prior versions that this document replaces.
- Codestring, nullReliable
A code for how the related document interacts with this document.
FHIR Document Relationship Type or CDA RelatedDocument TypeCode:APND(appends),RPLC(replaces), orXFRM(transforms). - IDstring, nullReliable
The ID of the related document
- SetIDstring, nullPossible
An ID for the document that is common across all document revisions.
WhenSetIDis provided,VersionNumberis required. - VersionNumberstring, nullPossible
An integer version number for the related revision of the document.
WhenSetIDis provided,VersionNumberis required.
- Localestring, nullReliable
The language of the document.
- Titlestring, nullReliable
The title of the document.
- DateTimestring, nullReliable
The creation/publishing date/time of the document.
- Typestring, nullReliable
The type of document.
This field is slated to be deprecated in favor of Header.Document.TypeCode.Name - TypeCodeobject
- Codestring, nullReliable
A code describing the type of document.
LOINC Document Type - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
Coding system to which the code belongs (LOINC preferred).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - Namestring, nullReliable
Name of the type of document.
Summarization of Episode Note, Progress Note, etc.
- Confidentialityobject
- Codestring, nullReliable
A code describing intended disclosure of information contained within the document.
N (Normal), R (Restricted), V (Very Restricted) - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of intended disclosure of information contained within the document
- Custodianobject
The organization or group responsible for the ongoing maintenance and access to the document
- IdentifiersArray of object
List of IDs specific to this custodian organization
- IDstring, nullProbable
An ID specific to this custodian organization
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Namenull, nullProbable
The name of the custodian organization
- Typeobject
- Codestring, nullProbable
A code describing the kind of custodian organization
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the kind of custodian organization
- AltCodesArray of object
Alternate or translation codes for the kind of custodian organization
- Codestring, nullPossible
A code describing the kind of custodian organization
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the kind of custodian organization
- Addressobject
The address information for the custodian organization
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- Usestring, nullProbable
Use
- TelecomArray of object
Phone, fax, email, or other communication numbers for the custodian organization
- Valuenull, nullProbable
The phone number or telecommunications address
- Usenull, nullProbable
The purpose of this telecommunications address (e.g. home, work, direct)
- Systemnull, nullProbable
The form of this address (e.g. phone, email, fax).
Supported Values
- Patientobject
- IdentifiersArray of object
An array of identifiers for the patient.
- IDstring, nullReliable
The actual identifier for the patient.
- IDTypestring, nullReliable
An ID type associated with identifier (Medical Record Number, etc.)
- Typestring, nullReliable
If present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.
- Demographicsobject
- FirstNamestring, nullReliable
Patient's first name
- MiddleNamestring, nullProbable
Patient's middle name
- LastNamestring, nullReliable
Patient's last name
- DOBstring, nullReliable
Patient's date of birth.
In YYYY-MM-DD format - SSNstring, nullReliable
Patient SSN
- Sexstring, nullReliableValue Set
Patient gender
- Addressobject
- StreetAddressstring, nullReliable
- Citystring, nullReliable
- Statestring, nullReliable
- Countystring, nullReliable
- Countrystring, nullReliable
- ZIPstring, nullReliable
- Usestring, nullPossible
- PhoneNumberobject
- Homestring, nullReliable
- Mobilestring, nullReliable
- EmailAddressesArray of object
- Addressstring, nullReliable
- Languagestring, nullPossible
Patient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values - Racestring, nullReliableValue Set
Patient's race - this is equivalent to the first RaceCodes[].Name
- RaceCodesArray of object
- Codestring, nullProbable
A code describing the patient's race
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the patient's race
- Ethnicitystring, nullReliable
One of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown
- EthnicGroupCodesArray of object
- Codestring, nullProbable
A code describing the patient's ethnicity
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the patient's ethnicity
- Religionstring, nullReliableValue Set
Patient's religious affiliation
- MaritalStatusstring, nullReliableValue Set
- IsDeceasedboolean, nullPossible
Indicates if the patient is deceased
- DeathDateTimestring, nullPossible
Date and Time the patient was proclaimed deceased.
ISO 8601 Format
- Organizationobject
Organization that is the custodian of the patient record
- IdentifiersArray of object
List of IDs specific to this organization
- IDstring, nullProbable
An ID specific to this organization
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Namenull, nullProbable
The name of the organization
- Typeobject
- Codestring, nullProbable
A code describing the kind of organization
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the kind of organization
- AltCodesArray of object
Alternate or translation codes for the kind of organization
- Codestring, nullPossible
A code describing the kind of organization
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the kind of organization
- Addressobject
The address information for the organization
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- Usestring, nullProbable
Use
- TelecomArray of object
Phone, fax, email, or other communication numbers for the organization
- Valuenull, nullProbable
The phone number or telecommunications address
- Usenull, nullProbable
The purpose of this telecommunications address (e.g. home, work, direct)
- Systemnull, nullProbable
The form of this address (e.g. phone, email, fax).
Supported Values
- PCPobject
- IDstring, nullPossible
ID of the Primary Care Provider for the Patient.
This ID is often required for Inpatient Visits. - IDTypestring, nullPossible
ID type of the ID for the Primary Care Provider for the Patient
- FirstNamestring, nullPossible
First name of the Primary Care Provider for the Patient
- LastNamestring, nullPossible
Last name of the Primary Care Provider for the Patient
- CredentialsArray of string
List of credentials for the Primary Care Provider for the Patient.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Typestring, nullPossibleValue Set
The type of Primary Care Provider for the Patient
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- AdvanceDirectivesTextstring, nullProbable
Free text form of the advance directives summary
- AdvanceDirectivesArray of object
- Typeobject
- Codestring, nullReliable
A code describing the type of advance directive (such as resuscitation).
SNOMED CT - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the type of advance directive (such as resuscitation)
- AltCodesArray of object
Alternate or translation codes for the type of advance directive (such as resuscitation)
- Codestring, nullPossible
A code describing the type of advance directive (such as resuscitation)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the type of advance directive (such as resuscitation)
- Codestring, nullReliable
A code describing the value of the advance directive (such as 'do not resuscitate').
SNOMED CT - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the value of the advance directive (such as 'do not resuscitate')
- AltCodesArray of object
Alternate or translation codes for the value of the advance directive (such as 'do not resuscitate')
- Codestring, nullPossible
A code describing the value of the advance directive (such as 'do not resuscitate')
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the value of the advance directive (such as 'do not resuscitate')
- StartDatestring, nullReliable
Effective start date of the advance directive.
ISO 8601 Format - EndDatestring, nullProbable
Effective end date of the advance directive.
ISO 8601 Format - ExternalReferencestring, nullProbable
A link to a location where the document can be accessed.
- VerifiedByArray of object
A collection of people who verified the advance directive with the patient
- FirstNamestring, nullProbable
- LastNamestring, nullProbable
- Credentialsstring, nullProbable
- DateTimestring, nullProbable
- CustodiansArray of object
People legally responsible for the advance directive document.
- FirstNamestring, nullProbable
- LastNamestring, nullProbable
- Credentialsstring, nullProbable
- Addressobject
- StreetAddressstring, nullProbable
- Citystring, nullProbable
- Statestring, nullProbable
- Countrystring, nullProbable
- ZIPstring, nullProbable
- AllergyTextstring, nullReliable
Free text form of the allergies summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup. - AllergiesArray of object
- Typeobject
- Codestring, nullReliable
A code describing the type of allergy intolerance this is (food, drug, etc.).
SNOMED CT from Allergy/Adverse Event Type Value Set - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the type of allergy intolerance this is (food, drug, etc.)
- AltCodesArray of object
Alternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)
- Codestring, nullPossible
A code describing the type of allergy intolerance this is (food, drug, etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the type of allergy intolerance this is (food, drug, etc.)
- Substanceobject
- CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the substance that the causes the allergy/intolerance
- AltCodesArray of object
Alternate or translation codes for the substance that the causes the allergy/intolerance
- Codestring, nullPossible
A code describing the substance that the causes the allergy/intolerance
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the substance that the causes the allergy/intolerance
- ReactionArray of object
All the reactions caused by this particular substance.
SNOMED CT- Codestring, nullReliable
A code describing the reaction caused by the allergy (dizziness, hives ,etc.).
SNOMED CT - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the reaction caused by the allergy (dizziness, hives ,etc.)
- AltCodesArray of object
Alternate or translation codes for the reaction caused by the allergy (dizziness, hives ,etc.)
- Codestring, nullPossible
A code describing the reaction caused by the allergy (dizziness, hives ,etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the reaction caused by the allergy (dizziness, hives ,etc.)
- Severityobject
- Codestring, nullReliable
A code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of a code for the severity of the reaction (moderate, severe, etc.)
- Textstring, nullReliable
Free text form of reactions to this substance, includes information that cannot be captured by coded value.
- Severityobject
- Codestring, nullPossible
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. - CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of a code for the severity of the reaction (moderate, severe, etc.).
- Criticalityobject
- Codestring, nullPossible
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. - CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
- Statusobject
- Codestring, nullReliable
A code describing the current status of the allergy (active, historic, etc.).
SNOMED CT (Active, Inactive, Resolved) - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the current status of the allergy (active, historic, etc.)
- IsNegativeIndicatorboolean, nullPossible
Absent or false for a normal allergy/intolerance; indicates that the allergy/intolerance is explicitly unlikely when true
- StartDatestring, nullProbable
When the allergy was first noted.
ISO 8601 Format - EndDatestring, nullProbable
When the allergy was no longer a problem (if applicable).
ISO 8601 Format - Commentstring, nullPossible
Free text comment about the allergy.
This field is slated to be deprecated in favor of Comments[].Text - CommentsArray of object
Free text comments about the allergy.
- Textstring, nullReliable
The plain text comment.
- CareTeamsTextstring, nullPossible
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. - CareTeamsArray of object
- Namestring, null
Name of the care team
- Statusstring, null
Status of the care team
- TypesArray of object
- Codestring, nullProbable
A code describing type of care team.
Care Team Category - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of type of care team
- AltCodesArray of object
Alternate or translation codes for type of care team
- Codestring, nullPossible
A code describing type of care team
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of type of care team
- Organizationobject
undefined
- IdentifiersArray of object
List of IDs specific to this organization
- IDstring, nullProbable
An ID specific to this organization
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Namenull, nullProbable
The name of the organization
- Typeobject
- Codestring, nullProbable
A code describing the kind of organization
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the kind of organization
- AltCodesArray of object
Alternate or translation codes for the kind of organization
- Codestring, nullPossible
A code describing the kind of organization
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the kind of organization
- Addressobject
The address information for the organization
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- Usestring, nullProbable
Use
- TelecomArray of object
Phone, fax, email, or other communication numbers for the organization
- Valuenull, nullProbable
The phone number or telecommunications address
- Usenull, nullProbable
The purpose of this telecommunications address (e.g. home, work, direct)
- Systemnull, nullProbable
The form of this address (e.g. phone, email, fax).
Supported Values
- Encounterobject
- IdentifiersArray of object
List of IDs specific to this encounter
- IDstring, nullProbable
An ID specific to this encounter
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Statusstring, nullProbable
The status of the encounter
- Typeobject
- Codestring, nullReliable
A code describing the type of encounter (office visit, hospital, etc).
CPT-4 - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the type of encounter (office visit, hospital, etc)
- AltCodesArray of object
Alternate or translation codes for the type of encounter (office visit, hospital, etc)
- Codestring, nullPossible
A code describing the type of encounter (office visit, hospital, etc)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the type of encounter (office visit, hospital, etc)
- DateTimestring, nullReliable
When the encounter took place, or alternatively when the encounter began if CareTeams[].Encounter.EndDateTime is present.
ISO 8601 Format - EndDateTimestring, nullPossible
When the encounter was completed, if available.
ISO 8601 Format
- MembersArray of object
Members of the care team
- IdentifiersArray of object
List of IDs and ID Types that identify the concept
- IDstring, nullReliable
ID for the concept
- IDTypestring, nullReliable
The type of ID
- FirstNamestring, null
First name of the care team member
- MiddleNamestring, null
Middle name of the care team member
- LastNamestring, null
Last name of the care team member
- CredentialsArray of string
Credentials of the care team member
- Addressobject
Physical address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- Usestring, nullProbable
Use
- TelecomArray of object
Phone, fax, email, or other communication numbers for the care team member
- Valuenull, null
The phone number or telecommunications address
- Usenull, null
The purpose of this telecommunications address (e.g. home, work, direct)
- Systemnull, null
The form of this address (e.g. phone, email, fax).
Supported Values
- StartDateTimestring, null
When the care team member joined the care team.
ISO 8601 Format - EndDateTimestring, null
When the care team member left the care team.
ISO 8601 Format - RolesArray of object
- Codestring, nullProbable
A code describing the roles of the care team member
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the roles of the care team member
- AltCodesArray of object
Alternate or translation codes for the roles of the care team member
- Codestring, nullPossible
A code describing the roles of the care team member
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the roles of the care team member
- EncountersTextstring, nullProbable
Free text form of the encounters summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup. - EncountersArray of object
- IdentifiersArray of object
List of IDs specific to this encounter
- IDstring, nullProbable
An ID specific to this encounter
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Statusstring, nullProbable
The status of the encounter
- Typeobject
- Codestring, nullReliable
A code describing the type of encounter (office visit, hospital, etc).
CPT-4 - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the type of encounter (office visit, hospital, etc)
- AltCodesArray of object
Alternate or translation codes for the type of encounter (office visit, hospital, etc)
- Codestring, nullPossible
A code describing the type of encounter (office visit, hospital, etc)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the type of encounter (office visit, hospital, etc)
- DateTimestring, nullReliable
When the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present.
ISO 8601 Format - EndDateTimestring, nullPossible
When the encounter was completed, if available.
ISO 8601 Format - ProvidersArray of object
- NPIstring, nullProbable
NPI of the Encounter Providers
- IDstring, nullProbable
ID of the Encounter Providers.
This ID is often required for Inpatient Visits. - IDTypestring, nullProbable
ID type of the ID for the Encounter Providers
- FirstNamestring, nullPossible
First name of the Encounter Providers
- LastNamestring, nullPossible
Last name of the Encounter Providers
- CredentialsArray of string
List of credentials for the Encounter Providers.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- Roleobject
- Codestring, nullProbable
A code describing the role of the provider (pcp, general physician, etc.)
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the role of the provider (pcp, general physician, etc.)
- AltCodesArray of object
Alternate or translation codes for the role of the provider (pcp, general physician, etc.)
- Codestring, nullPossible
A code describing the role of the provider (pcp, general physician, etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the role of the provider (pcp, general physician, etc.)
- LocationsArray of object
- IdentifiersArray of object
List of IDs specific to this location
- IDstring, nullProbable
An ID specific to this location
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- TelecomArray of object
Phone, fax, email, or other communication numbers for the location
- Valuenull, nullProbable
The phone number or telecommunications address
- Usenull, nullProbable
The purpose of this telecommunications address (e.g. home, work, direct)
- Systemnull, nullProbable
The form of this address (e.g. phone, email, fax).
Supported Values
- Addressobject
- StreetAddressstring, nullProbable
- Citystring, nullProbable
- Statestring, nullProbable
- Countrystring, nullProbable
- ZIPstring, nullProbable
- Typeobject
- Codestring, nullProbable
A code describing the type of location where the patient was seen (clinic, urgent care, hospital).
Healthcare Service Location - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the type of location where the patient was seen (clinic, urgent care, hospital)
- AltCodesArray of object
Alternate or translation codes for the type of location where the patient was seen (clinic, urgent care, hospital)
- Codestring, nullPossible
A code describing the type of location where the patient was seen (clinic, urgent care, hospital)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the type of location where the patient was seen (clinic, urgent care, hospital)
- Namestring, nullProbable
The name of the location
- DiagnosisArray of object
An array of diagnoses
- StartDatestring, nullProbable
The onset date of the diagnosis.
ISO 8601 Format - EndDatestring, nullProbable
The resolution date of the diagnosis.
ISO 8601 Format - Statusobject
- Codestring, nullPossible
A code describing the current state of the diagnosis (active, inactive, resolved).
HITSPProblemStatus - CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the current state of the diagnosis (active, inactive, resolved)
- IsNegativeIndicatorboolean, nullPossible
Absent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true
- Codestring, nullProbable
A code describing the diagnosis.
ICD9, ICD10, HCPC, CPT, SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the diagnosis
- AltCodesArray of object
Alternate or translation codes for the diagnosis
- Codestring, nullPossible
A code describing the diagnosis
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the diagnosis
- CommentsArray of object
Free text comments about the diagnosis.
- Textstring, nullReliable
The plain text comment.
- ReasonForVisitArray of object
- Codestring, nullProbable
A code describing the reason for the encounter (usually this is what the patient reports).
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the reason for the encounter (usually this is what the patient reports)
- AltCodesArray of object
Alternate or translation codes for the reason for the encounter (usually this is what the patient reports)
- Codestring, nullPossible
A code describing the reason for the encounter (usually this is what the patient reports)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the reason for the encounter (usually this is what the patient reports)
- DischargeDispositionobject
- Codestring, nullProbable
A code describing the discharge disposition of the visit.
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the discharge disposition of the visit.
- AltCodesArray of object
Alternate or translation codes for the discharge disposition of the visit.
- Codestring, nullPossible
A code describing the discharge disposition of the visit.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the discharge disposition of the visit.
- FamilyHistoryTextstring, nullProbable
Free text form of the family history summary
- FamilyHistoryArray of object
Each element of the FamilyHistory is one person in the patient's family.
- Relationobject
- Codestring, nullReliable
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) - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the family member's relationship (father, mother, maternal grandfather, etc.)
- Demographicsobject
- Sexstring, nullProbableValue Set
Gender of the relative
- DOBstring, nullProbable
Date of Birth of the relative.
In YYYY-MM-DD format
- IsDeceasedboolean, nullProbable
Whether or not the relative is deceased
- ProblemsArray of object
A list of the relative's relevant health problems
- Codestring, nullReliable
A code describing a particular problem experienced by the relative.
SNOMED CT - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of a particular problem experienced by the relative
- AltCodesArray of object
Alternate or translation codes for a particular problem experienced by the relative
- Codestring, nullPossible
A code describing a particular problem experienced by the relative
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of a particular problem experienced by the relative
- Typeobject
- Codestring, nullReliable
A code describing the general class of the problem. (disease, problem, etc.).
Problem Type Value Set - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the general class of the problem. (disease, problem, etc.)
- DateTimestring, nullProbable
The time when the problem started.
ISO 8601 Format - AgeAtOnsetstring, nullProbable
The relative's age when the problem started
- IsCauseOfDeathboolean, nullProbable
Flag indicating whether or not this problem was the cause of death for the relative.
- FunctionalStatusTextstring, nullPossible
Free text form of the functional status summary
- FunctionalStatusobject
- ObservationsArray of object
Various types of observations about the patient's functional status.
- Codestring, nullProbable
A code describing a type of observation (functional status, activities of daily living, sensory status, etc.). .
LOINC - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of a type of observation (functional status, activities of daily living, sensory status, etc.).
- AltCodesArray of object
Alternate or translation codes for a type of observation (functional status, activities of daily living, sensory status, etc.).
- Codestring, nullPossible
A code describing a type of observation (functional status, activities of daily living, sensory status, etc.).
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of a type of observation (functional status, activities of daily living, sensory status, etc.).
- DateTimestring, nullProbable
A specific date/time when the value was recorded.
ISO 8601 Format - CodedValueobject
- Codestring, nullPossible
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 - CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the individual observation value, if a coded value.
- AltCodesArray of object
Alternate or translation codes for the individual observation value, if a coded value.
- Codestring, nullPossible
A code describing the individual observation value, if a coded value.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the individual observation value, if a coded value.
- Valuestring, nullProbable
The measurement recorded for the functional status observation.
- Unitsstring, nullProbable
The units of the measurement.
UCUM Units of Measure - ReferenceRangeobject
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.- Lownumber, nullPossible
Lower bound for a normal observation
- Highnumber, nullPossible
Upper bound for a normal observation
- Textstring, nullPossible
The normal value for non-numeric observations
- CommentsArray of object
Free text comments about the observation.
- Textstring, nullReliable
The plain text comment.
- SuppliesArray of object
Non-medicinal supplies provided to the patient in the context of assessing the patient's physical abilities.
- Codestring, nullProbable
A code describing the supplied product.
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the supplied product
- AltCodesArray of object
Alternate or translation codes for the supplied product
- Codestring, nullPossible
A code describing the supplied product
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the supplied product
- Statusstring, nullProbable
The state of the supplied product (intent, confirmed, etc).
Plan of care status - DateTimestring, nullProbable
The date/time of the activity. .
ISO 8601 Format
- GoalsTextstring, nullProbable
Free text form of the goals summary
- GoalsArray of object
List of goals or targets for patient care.
- Codestring, nullProbable
A code describing the patient health goal.
LOINC - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the patient health goal.
- AltCodesArray of object
Alternate or translation codes for the patient health goal.
- Codestring, nullPossible
A code describing the patient health goal.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the patient health goal.
- DateTimestring, nullProbable
A specific date/time when the goal was recorded.
ISO 8601 Format - CodedValueobject
- Codestring, nullPossible
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 - CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the individual goal or target value, if a coded value.
- AltCodesArray of object
Alternate or translation codes for the individual goal or target value, if a coded value.
- Codestring, nullPossible
A code describing the individual goal or target value, if a coded value.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the individual goal or target value, if a coded value.
- Valuestring, nullProbable
The individual goal or target value.
- Unitsstring, nullProbable
The units of the measurement.
UCUM Units of Measure - StartDatestring, nullProbable
Start date of goal.
- EndDatestring, nullProbable
Target completion date for goal.
- Priorityobject
- Codestring, nullPossible
A code describing the level of importance associated with the goal.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the level of importance associated with the goal.
- AchievementStatusobject
- Codestring, nullPossible
A code describing progression, or lack thereof, towards the goal.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of progression, or lack thereof, towards the goal.
- MilestonesArray of object
List of goals or targets for patient care.
- Codestring, nullProbable
A code describing the patient health goal.
LOINC - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the patient health goal.
- AltCodesArray of object
Alternate or translation codes for the patient health goal.
- Codestring, nullPossible
A code describing the patient health goal.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the patient health goal.
- DateTimestring, nullProbable
A specific date/time when the goal was recorded.
ISO 8601 Format - CodedValueobject
- Codestring, nullPossible
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 - CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the individual goal or target value, if a coded value.
- AltCodesArray of object
Alternate or translation codes for the individual goal or target value, if a coded value.
- Codestring, nullPossible
A code describing the individual goal or target value, if a coded value.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the individual goal or target value, if a coded value.
- Valuestring, nullProbable
The individual goal or target value.
- Unitsstring, nullProbable
The units of the measurement.
UCUM Units of Measure - StartDatestring, nullProbable
Start date of goal.
- EndDatestring, nullProbable
Target completion date for goal.
- Priorityobject
- Codestring, nullPossible
A code describing the level of importance associated with the goal.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the level of importance associated with the goal.
- AchievementStatusobject
- Codestring, nullPossible
A code describing progression, or lack thereof, towards the goal.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of progression, or lack thereof, towards the goal.
- CommentsArray of object
Free text comments about the goal.
- Textstring, nullReliable
The plain text comment.
- HealthConcernsTextstring, nullReliable
Free text form of the health concerns summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup. - HealthConcernsArray of object
An array of all of patient relevant health concerns, current and historical.
- ConcernTypestring, nullReliable
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 - Categoryobject
- Codestring, nullReliable
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 - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.
- AltCodesArray of object
Alternate or translation codes for a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.
- Codestring, nullPossible
A code describing a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.
- StartDatestring, nullProbable
When the health concern was noticed.
ISO 8601 Format - EndDatestring, nullProbable
When the health concern stopped (if it is not current).
ISO 8601 Format - Codestring, nullReliable
A code describing the actual health concern.
LOINC or SNOMED CT - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the actual health concern
- AltCodesArray of object
Alternate or translation codes for the actual health concern
- Codestring, nullPossible
A code describing the actual health concern
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the actual health concern
- Valuenull, nullPossible
Observed value, required if the concern is an observation.
- Unitsnull, nullPossible
The units of measurement if the concern is an observation.
UCUM Units of Measure - Interpretationstring, nullPossible
A flag indicating whether or not the observed value is normal, high, or low.
Supported Values - TargetSiteobject
- Codestring, nullPossible
A code describing the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.
- AltCodesArray 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.
- Codestring, nullPossible
A code describing the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.
- Statusstring, nullProbable
The current state of the health concern (active, inactive)
- CommentsArray of object
Free text comments about the health concern.
- Textstring, nullReliable
The plain text comment.
- ImmunizationTextstring, nullProbable
Free text form of the immunization summary
- ImmunizationsArray of object
Array of immunizations for patient.
- DateTimestring, nullReliable
When the immunization was given.
ISO 8601 Format - Routeobject
- Codestring, nullProbable
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) - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the way in which the immunization was delivered (intramuscular, oral, etc.)
- AltCodesArray of object
Alternate or translation codes for the way in which the immunization was delivered (intramuscular, oral, etc.)
- Codestring, nullPossible
A code describing the way in which the immunization was delivered (intramuscular, oral, etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the way in which the immunization was delivered (intramuscular, oral, etc.)
- Statusstring, nullPossible
The status of the immunization.
- Productobject
- Manufacturerstring, nullProbable
Name of organization that manufacture the immunization.
Free text - Codestring, nullReliable
A code describing the vaccination that was given.
CVX code system - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the vaccination that was given
- AltCodesArray of object
Alternate or translation codes for the vaccination that was given
- Codestring, nullPossible
A code describing the vaccination that was given
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the vaccination that was given
- LotNumberstring, nullProbable
The lot number of the vaccine
- Doseobject
- Quantitystring, nullProbable
The size of the dose
- Unitsstring, nullProbable
The units of the dose.
UCUM Units of Measure
- ReasonNotGivenstring, nullPossible
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 - AdministrationHistoryArray of object
A list of recent administrations of this immunization
- StartDatestring, nullPossible
When the immunization administration was started.
ISO 8601 Format - EndDatestring, nullPossible
When the immunization administration ended.
ISO 8601 Format
- InsurancesTextstring, nullPossible
Free text form of the patient's insurances.
When sent via Redox API, this can ONLY be pushed as plain text without any markup. - InsurancesArray of object
List of insurance coverages for the patient
- Planobject
- IDstring, nullProbable
Identifier of insurance plan
- IDTypestring, nullProbable
ID type of insurance plan
- Namestring, nullProbable
Name of insurance plan
- Typestring, nullPossible
Type of insurance plan
- MemberNumberstring, nullPossible
Patient member number
- Companyobject
- IDstring, nullPossible
ID of insurance company (payor).
Typically not available in ClinicalSummary. - IDTypestring, nullPossible
ID type of insurance company (payor).
Typically not available in ClinicalSummary. - Namestring, nullProbable
Name of insurance company (payor)
- Addressobject
Insurance company's address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- Usestring, nullProbable
Use
- PhoneNumberstring, nullProbable
Insurance companys phone number.
In E. 164 Format (i.e. +16085551234)
- GroupNumberstring, nullProbable
Insurance policy group number
- GroupNamestring, nullPossible
Insurance policy group name.
Typically not available in ClinicalSummary. - EffectiveDatestring, nullProbable
Effect date of this insurance policy.
In YYYY-MM-DD format - ExpirationDatestring, nullProbable
Expiration date of this insurance policy.
In YYYY-MM-DD format - PolicyNumberstring, nullProbable
Insurance policy number
- Prioritystring, nullPossibleValue Set
The insurance priority sequence.
If the insurance works in conjunction with other insurance plans, this field contains priority sequence. - AgreementTypestring, nullPossible
Type of insurance agreement.
Typically not available in ClinicalSummary. - CoverageTypestring, nullProbableValue Set
Type of insurance agreement.
Indicates who will be receiving the bill for the service. - Insuredobject
Individual who has the agreement with the insurance company for the related policy
- IdentifiersArray of object
List of IDs and ID types that identify the insured
- IDstring, nullPossible
ID for the insured
- IDTypestring, nullPossible
Type of ID.
E.g. MRN, EPI
- LastNamestring, nullPossible
Last name of the insured
- MiddleNamestring, nullPossible
Middle name of the insured
- FirstNamestring, nullPossible
First name of the insured
- SSNstring, nullPossible
Insured's social security number
- Relationshipstring, nullPossibleValue Set
Relationship of the insured to the patient
- DOBstring, nullPossible
Date of birth of the insured.
In YYYY-MM-DD format - Sexstring, nullPossibleValue Set
Sex of the insured
- Addressobject
Address of the insured
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- Usestring, nullProbable
Use
- MedicalEquipmentTextstring, nullProbable
Free text form of the medical equipment summary
- MedicalEquipmentArray of object
A list of medical equipment that the patient uses (cane, pacemakers, etc.)
- Statusstring, nullReliable
The current status of the equipment (active, completed, etc.)
- StartDatestring, nullProbable
When the equipment was first put into use.
ISO 8601 Format - Quantitystring, nullProbable
The number of products used
- CommentsArray of object
Free text comments about the device or equipment.
- Textstring, nullReliable
The plain text comment.
- Productobject
- Codestring, nullProbable
A code describing the actual product.
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the actual product.
- AltCodesArray of object
Alternate or translation codes for the actual product.
- Codestring, nullPossible
A code describing the actual product.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the actual product.
- IdentifiersArray of object
Identifiers for the equipement or device.
Unique Device Identifier (UDI) components are present in other fields.- IDstring, nullProbable
ID for the equipment or device
- IDTypestring, nullProbable
Type of ID
- DeviceIDstring, nullProbable
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.
- Issuerstring, nullProbable
Organization that is charged with issuing UDIs for devices.
GS1, HIBCC, ICCBBA, ICCBA - SerialNumberstring, nullProbable
The device serial number
- DistinctIDstring, nullProbable
The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
- ManufacturerNamestring, nullProbable
The name of the manufacturer
- LotNumberstring, nullProbable
Lot or batch number assigned by the manufacturer
- ManufactureDatestring, nullProbable
The date the product was manufactured.
In ISO 8601 format - ExpirationDatestring, nullProbable
The date and time beyond which this device is no longer valid or should not be used (if applicable).
In ISO 8601 format - BrandNamestring, nullProbable
The name of the device as given by the manufacturer
- ModelNumberstring, nullProbable
The manufacturer's model number for the device
- CatalogNumberstring, nullProbable
The part number or catalog number of the device
- Statusobject
- Codestring, nullProbable
A code describing the status of the patient's implantable medical device.
Implantable Device Status Value Set - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the status of the patient's implantable medical device
- SafetyObservationsArray of object
- Codestring, nullProbable
A code describing additional safety characteristics about a medical device. for example devices containing latex.
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of additional safety characteristics about a medical device. for example devices containing latex.
- AltCodesArray of object
Alternate or translation codes for additional safety characteristics about a medical device. for example devices containing latex.
- Codestring, nullPossible
A code describing additional safety characteristics about a medical device. for example devices containing latex.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of additional safety characteristics about a medical device. for example devices containing latex.
- Procedureobject
- Codestring, nullProbable
A code describing the procedure performed during which the device was implanted
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the procedure performed during which the device was implanted
- AltCodesArray of object
Alternate or translation codes for the procedure performed during which the device was implanted
- Codestring, nullPossible
A code describing the procedure performed during which the device was implanted
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the procedure performed during which the device was implanted
- TargetSiteobject
- Codestring, nullProbable
A code describing the location on the body where the device was implanted
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the location on the body where the device was implanted
- AltCodesArray of object
Alternate or translation codes for the location on the body where the device was implanted
- Codestring, nullPossible
A code describing the location on the body where the device was implanted
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the location on the body where the device was implanted
- MedicationsTextstring, nullReliable
Free text form of the medications summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup. - MedicationsArray of object
- Prescriptionboolean, nullReliable
Whether the medication is a prescription.
For a prescription: true. For a patient reported med, or a med administered by a provider: false - FreeTextSigstring, nullPossible
Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
- Doseobject
- Quantitystring, nullProbable
The size of the dose for pills, capsules, etc.
- Unitsstring, nullProbable
The units of the dose.
UCUM Units of Measure
- Rateobject
- Quantitystring, nullProbable
If the medication is in liquid form, the rate at which it is administered
- Unitsstring, nullProbable
Units for the rate.
UCUM Units of Measure
- Routeobject
- Codestring, nullProbable
A code describing the method by which the medication is delivered.
Medication Route FDA Value Set - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the method by which the medication is delivered
- AltCodesArray of object
Alternate or translation codes for the method by which the medication is delivered
- Codestring, nullPossible
A code describing the method by which the medication is delivered
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the method by which the medication is delivered
- Statusstring, nullPossible
The status of the medication.
- StartDatestring, nullReliable
When the medication was started.
ISO 8601 Format - EndDatestring, nullProbable
When the medication ended.
ISO 8601 Format - Frequencyobject
- Periodstring, nullProbable
How often the patient should be taking the medication
- PeriodMaxstring, nullPossible
How often the patient should be taking the medication at a maximum
- Unitstring, nullProbable
Units for how often the patient should be taking the medication.
UCUM Units of Measure - EventCodestring, nullPossible
Real world event that describes the frequency.
HL7 Timing Event - InstitutionSpecifiedboolean, nullPossible
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".)
- NumberOfRefillsRemainingnumber, nullPossible
The number of authorized refills remaining on the prescription
- TotalRefillsnumber, nullProbable
The total number of refills prescribed
- LastRefillDatestring, nullProbable
The date the refill was last filled.
ISO 8601 Format - IsPRNboolean, nullProbable
Whether the medication is to be taken on an as-needed basis
- Productobject
- Codestring, nullReliable
A code describing the actual medication given .
RxNorm - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the actual medication given
- AltCodesArray of object
Alternate or translation codes for the actual medication given
- Codestring, nullPossible
A code describing the actual medication given
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the actual medication given
- IndicationsArray of object
- Codestring, nullPossible
A code describing the reason the medication was given.
SNOMED CT - CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the reason the medication was given
- AltCodesArray of object
Alternate or translation codes for the reason the medication was given
- Codestring, nullPossible
A code describing the reason the medication was given
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the reason the medication was given
- SupplyOrderobject
- StartDatestring, nullReliable
When the medication supply order was starts.
ISO 8601 Format - EndDatestring, nullProbable
When the medication supply order ends.
ISO 8601 Format - Quantitystring, nullProbable
The quantity of the medication supply order
- Unitsstring, nullProbable
The units of the supply order.
UCUM Units of Measure - NumberOfRefillsRemainingnumber, nullPossible
The number of authorized refills remaining on the medication supply order
- AdministrationHistoryArray of object
A list of recent administrations of this medication
- StartDatestring, nullPossible
When the medication administration was started.
ISO 8601 Format - EndDatestring, nullPossible
When the medication administration ended.
ISO 8601 Format
- PlanOfCareTextstring, nullProbable
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. - PlanOfCareobject
- OrdersArray of object
Future lab tests or other diagnostic procedures.
- Codestring, nullProbable
A code describing the test to be performed .
LOINC - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the test to be performed
- AltCodesArray of object
Alternate or translation codes for the test to be performed
- Codestring, nullPossible
A code describing the test to be performed
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the test to be performed
- Statusstring, nullProbable
The state of the plan (intent, confirmed, etc).
Plan of care status - DateTimestring, nullProbable
- ProceduresArray of object
Future procedures.
- Codestring, nullProbable
A code describing the planned procedure, such as an appendectomy or hip replacement .
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the planned procedure, such as an appendectomy or hip replacement
- AltCodesArray of object
Alternate or translation codes for the planned procedure, such as an appendectomy or hip replacement
- Codestring, nullPossible
A code describing the planned procedure, such as an appendectomy or hip replacement
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the planned procedure, such as an appendectomy or hip replacement
- Statusstring, nullProbable
The state of the plan (intent, confirmed, etc).
Plan of care status - DateTimestring, nullProbable
- EncountersArray of object
Appointments and other upcoming encounters
- Codestring, nullProbable
A code describing the planned encounter type .
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the planned encounter type
- AltCodesArray of object
Alternate or translation codes for the planned encounter type
- Codestring, nullPossible
A code describing the planned encounter type
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the planned encounter type
- IdentifiersArray of object
List of IDs and ID types that identifies the encounter
- IDstring, nullPossible
ID for the encounter
- IDTypestring, nullPossible
Type of ID
- Statusstring, nullProbable
The state of the plan (intent, confirmed, etc).
Plan of care status - DateTimestring, nullProbable
- MedicationAdministrationArray of object
Planned medication
- Statusstring, nullProbable
The state of the plan (intent, confirmed, etc).
Plan of care status - Doseobject
- Quantitystring, nullProbable
The size of the dose for pills, capsules, etc.
- Unitsstring, nullProbable
The units of the dose.
UCUM Units of Measure
- Rateobject
- Quantitystring, nullProbable
If the medication is not in does form, this is the rate at which is administered
- Unitsstring, nullProbable
Units for the rate.
UCUM Units of Measure
- Routeobject
- Codestring, nullProbable
A code describing the method by which the medication is to be delivered.
Medication Route FDA Value Set - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the method by which the medication is to be delivered
- AltCodesArray of object
Alternate or translation codes for the method by which the medication is to be delivered
- Codestring, nullPossible
A code describing the method by which the medication is to be delivered
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the method by which the medication is to be delivered
- StartDatestring, nullProbable
When the medication was started
- EndDatestring, nullProbable
When the medication ended
- Frequencyobject
- Periodstring, nullProbable
How often the patient should be taking the medication.
UCUM Units of measure - Unitstring, nullProbable
Units for how often the patient should be taking the medication
- Productobject
- Codestring, nullProbable
A code describing the planned medication .
RxNorm - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the planned medication
- AltCodesArray of object
Alternate or translation codes for the planned medication
- Codestring, nullPossible
A code describing the planned medication
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the planned medication
- SuppliesArray of object
Future supplies that a patient may be given, including implants.
- Codestring, nullProbable
A code describing the planned product.
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the planned product
- AltCodesArray of object
Alternate or translation codes for the planned product
- Codestring, nullPossible
A code describing the planned product
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the planned product
- Statusstring, nullProbable
The state of the plan (intent, confirmed, etc).
Plan of care status - DateTimestring, nullProbable
The scheduled time of the activity. .
ISO 8601 Format
- ServicesArray of object
Planned activities that are service-oriented in nature, such as a dressing change, or feeding a patient.
- Codestring, nullProbable
A code describing the planned activity.
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the planned activity.
- AltCodesArray of object
Alternate or translation codes for the planned activity.
- Codestring, nullPossible
A code describing the planned activity.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the planned activity.
- Statusstring, nullProbable
The state of the plan (intent, confirmed, etc).
Plan of care status - DateTimestring, nullProbable
The scheduled time of the activity. .
ISO 8601 Format
- ProblemsTextstring, nullReliable
Free text form of the problems summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup. - ProblemsArray of object
An array of all of patient relevant problems, both current and historical.
- StartDatestring, nullProbable
When the problem was noticed.
ISO 8601 Format - EndDatestring, nullProbable
When the problem stopped (if it is not current).
ISO 8601 Format - Codestring, nullReliable
A code describing the actual problem .
SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009) - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the actual problem
- AltCodesArray of object
Alternate or translation codes for the actual problem
- Codestring, nullPossible
A code describing the actual problem
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the actual problem
- Categoryobject
- Codestring, nullReliable
A code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
- CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the type of problem this is (complaint, diagnosis, symptom, etc.)
- AltCodesArray of object
Alternate or translation codes for the type of problem this is (complaint, diagnosis, symptom, etc.)
- Codestring, nullPossible
A code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the type of problem this is (complaint, diagnosis, symptom, etc.)
- Statusobject
- Codestring, nullProbable
A code describing the current state of the problem (active, inactive, resolved).
HITSPProblemStatus - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the current state of the problem (active, inactive, resolved)
- Commentstring, nullPossible
Free text comment about the problem.
This field is slated to be deprecated in favor of Comments[].Text - CommentsArray of object
Free text comments about the problem.
- Textstring, nullReliable
The plain text comment.
- HealthStatusobject
- Codestring, nullPossible
A code describing the effect of the problem on the patient (chronically ill, in remission, etc.).
SNOMED-CT - CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the effect of the problem on the patient (chronically ill, in remission, etc.)
- AltCodesArray of object
Alternate or translation codes for the effect of the problem on the patient (chronically ill, in remission, etc.)
- Codestring, nullPossible
A code describing the effect of the problem on the patient (chronically ill, in remission, etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the effect of the problem on the patient (chronically ill, in remission, etc.)
- ProceduresTextstring, nullProbable
Free text form of the procedures summary
- Proceduresobject
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.
- ObservationsArray of object
These are procedures that are more observational in nature, such as an EEG or EKG.
- Codestring, nullProbable
A code describing the procedure that was performed. .
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the procedure that was performed.
- AltCodesArray of object
Alternate or translation codes for the procedure that was performed.
- Codestring, nullPossible
A code describing the procedure that was performed.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the procedure that was performed.
- DateTimestring, nullProbable
When the procedure was performed.
- Statusstring, nullProbable
The status of the procedure.
- TargetSiteobject
- Codestring, nullProbable
A code describing the location on the body where the procedure was performed.
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the location on the body where the procedure was performed
- AltCodesArray of object
Alternate or translation codes for the location on the body where the procedure was performed
- Codestring, nullPossible
A code describing the location on the body where the procedure was performed
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the location on the body where the procedure was performed
- CommentsArray of object
Free text comments about the procedure.
- Textstring, nullReliable
The plain text comment.
- ProceduresArray of object
These are procedures that alter the state of the body, such as an appendectomy or hip replacement.
- Codestring, nullProbable
A code describing the procedure that was performed. .
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the procedure that was performed.
- AltCodesArray of object
Alternate or translation codes for the procedure that was performed.
- Codestring, nullPossible
A code describing the procedure that was performed.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the procedure that was performed.
- DateTimestring, nullProbable
When the procedure was performed.
- Statusstring, nullProbable
The status of the procedure.
- TargetSiteobject
- Codestring, nullProbable
A code describing the location on the body where the procedure was performed.
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the location on the body where the procedure was performed
- AltCodesArray of object
Alternate or translation codes for the location on the body where the procedure was performed
- Codestring, nullPossible
A code describing the location on the body where the procedure was performed
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the location on the body where the procedure was performed
- CommentsArray of object
Free text comments about the procedure.
- Textstring, nullReliable
The plain text comment.
- ServicesArray of object
These are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient.
- Codestring, nullProbable
A code describing the procedure that was performed. .
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the procedure that was performed.
- AltCodesArray of object
Alternate or translation codes for the procedure that was performed.
- Codestring, nullPossible
A code describing the procedure that was performed.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the procedure that was performed.
- DateTimestring, nullProbable
When the procedure was performed.
- Statusstring, nullProbable
The status of the procedure.
- CommentsArray of object
Free text comments about the procedure.
- Textstring, nullReliable
The plain text comment.
- ResolvedProblemsTextstring, nullReliable
Free text form of the problems summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup. - ResolvedProblemsArray of object
An array of historical problems and diagnoses that are no longer being tracked.
- StartDatestring, nullProbable
When the problem was noticed.
ISO 8601 Format - EndDatestring, nullProbable
When the problem stopped (if it is not current).
ISO 8601 Format - Codestring, nullReliable
A code describing the actual problem .
SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009) - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the actual problem
- AltCodesArray of object
Alternate or translation codes for the actual problem
- Codestring, nullPossible
A code describing the actual problem
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the actual problem
- Categoryobject
- Codestring, nullReliable
A code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
- CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the type of problem this is (complaint, diagnosis, symptom, etc.)
- AltCodesArray of object
Alternate or translation codes for the type of problem this is (complaint, diagnosis, symptom, etc.)
- Codestring, nullPossible
A code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the type of problem this is (complaint, diagnosis, symptom, etc.)
- Statusobject
- Codestring, nullProbable
A code describing the current state of the problem (active, inactive, resolved).
HITSPProblemStatus - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the current state of the problem (active, inactive, resolved)
- Commentstring, nullPossible
Free text comment about the problem.
This field is slated to be deprecated in favor of Comments[].Text - CommentsArray of object
Free text comments about the problem.
- Textstring, nullReliable
The plain text comment.
- ResultTextstring, nullReliable
Free text form of the results summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup. - ResultsArray of object
Array of test results for the patient. This can include laboratory results, imaging results, and procedure results.
- Codestring, nullReliable
A code describing the test performed and resulted.
LOINC for Lab, SNOMED CT otherwise - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the test performed and resulted.
- AltCodesArray of object
Alternate or translation codes for the test performed and resulted.
- Codestring, nullPossible
A code describing the test performed and resulted.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the test performed and resulted.
- Encounterobject
Encounter associated with this result (if different from the encompassing encounter)
- IdentifiersArray of object
List of IDs specific to this encounter
- IDstring, nullPossible
An ID specific to this encounter
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Statusstring, nullPossible
The status of the encounter
- Typeobject
- Codestring, nullReliable
A code describing the type of encounter (office visit, hospital, etc).
CPT-4 - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the type of encounter (office visit, hospital, etc)
- AltCodesArray of object
Alternate or translation codes for the type of encounter (office visit, hospital, etc)
- Codestring, nullPossible
A code describing the type of encounter (office visit, hospital, etc)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the type of encounter (office visit, hospital, etc)
- DateTimestring, nullReliable
When the encounter took place, or alternatively when the encounter began if Results[].Encounter.EndDateTime is present.
ISO 8601 Format - EndDateTimestring, nullPossible
When the encounter was completed, if available.
ISO 8601 Format
- Statusstring, nullReliable
The status of the test (In Progress, Final)
- Producerobject
- IDstring, nullPossible
ID of the producer for this result.
The "Producer" is typically the Lab which did the resulting. - Namestring, nullPossible
Name of the producer
- IDTypestring, nullPossible
ID Type for the corresponding ID of this producer
- Addressobject
Result producer's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- Usestring, nullPossible
Use
- Specimenobject
Details about the target of focused laboratory, radiology or other observations
- CollectionDateTimenull, nullPossible
A specific date/time when the specimen was collected
- IdentifiersArray 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 ^.
- Sourceobject
- Codestring, nullPossible
A code describing code or name describing the specimen
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of code or name describing the specimen
- TargetSiteobject
- Codestring, nullPossible
A code describing code specifying detail about the anatomical site or system that is the focus of the observation
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of code specifying detail about the anatomical site or system that is the focus of the observation
- ObservationsArray of object
A list of corresponding observations for the test (result components)
- Codestring, nullReliable
A code describing the individual result component. .
LOINC for Lab, SNOMED CT otherwise - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the individual result component.
- AltCodesArray of object
Alternate or translation codes for the individual result component.
- Codestring, nullPossible
A code describing the individual result component.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the individual result component.
- Statusstring, nullReliable
The status of the individual component. Some tests may have different components finish at different times. .
One of (In Progress, Final) - Interpretationstring, nullProbable
A flag indicating whether or not the observed value is normal, high, or low.
Supported Values - DateTimestring, nullReliable
A specific date/time when the value was recorded.
ISO 8601 Format - CodedValueobject
- Codestring, nullPossible
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 - CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the individual result value.
- AltCodesArray of object
Alternate or translation codes for the individual result value.
- Codestring, nullPossible
A code describing the individual result value.
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the individual result value.
- Valuestring, nullReliable
The measurement recorded for the result.
- ValueTypestring, nullReliable
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. - FileTypestring, nullPossible
The file content type of the encapsulated data.
Only available when ValueType is Encapsulated Data - Unitsstring, nullReliable
The units of the measurement.
Only available when ValueType is PhysicalQuantity - ReferenceRangeobject
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.- Lowstring, nullPossible
Lower bound for a normal result
- Highstring, nullPossible
Upper bound for a normal result
- Textstring, nullPossible
The normal value for non-numeric results
- CommentsArray of object
Free text comments about the result.
- Textstring, nullReliable
The plain text comment.
- SocialHistoryTextstring, nullProbable
Free text form of the social history summary
- SocialHistoryobject
- ObservationsArray of object
Generic observations about the patient's social history that don't fall into the smoking or pregnancy categories.
- Codestring, nullProbable
A code describing a type of social history observation (exercise, alcohol intake, etc.) .
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of a type of social history observation (exercise, alcohol intake, etc.)
- AltCodesArray of object
Alternate or translation codes for a type of social history observation (exercise, alcohol intake, etc.)
- Codestring, nullPossible
A code describing a type of social history observation (exercise, alcohol intake, etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of a type of social history observation (exercise, alcohol intake, etc.)
- Valueobject
The observed value
- Codestring, nullProbable
A code describing the observed value, if coded
- CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the observed value, if coded
- AltCodesArray of object
Alternate or translation codes for the observed value, if coded
- Codestring, nullPossible
A code describing the observed value, if coded
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the observed value, if coded
- ValueTextstring, nullProbable
The observed value, if un-coded
- Unitsstring, nullPossible
The units of the measurement, if the observed value is a quantity.
UCUM Units of Measure - StartDatestring, nullProbable
Start date of status
- EndDatestring, nullProbable
Date status ended. If this is null, the status is current.
- CommentsArray of object
Free text comments about the observation.
- Textstring, nullReliable
The plain text comment.
- PregnancyArray of object
Information about past and current pregnancies.
- StartDatestring, nullProbable
When the pregnancy started.
ISO 8601 Format - EndDatestring, nullProbable
When the pregnancy ended.
ISO 8601 Format - EstimatedDeliverystring, nullProbable
Estimate delivery date if pregnancy is still active.
- CommentsArray of object
Free text comments about the pregnancy.
- Textstring, nullReliable
The plain text comment.
- TobaccoUseArray of object
Contains tobacco use and smoking status observations
- Codestring, nullProbable
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 - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the use of tobacco (current smoker, never smoker, snuff user, etc.)
- AltCodesArray of object
Alternate or translation codes for the use of tobacco (current smoker, never smoker, snuff user, etc.)
- Codestring, nullPossible
A code describing the use of tobacco (current smoker, never smoker, snuff user, etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the use of tobacco (current smoker, never smoker, snuff user, etc.)
- IsSmokingStatusboolean, nullProbable
Identifies this tobacco use entry as a smoking status.
If true, StartDate is the date the smoking status was observed. - StartDatestring, nullProbable
Start date of status.
If IsSmokingStatus is true, this is the date the observation was made. - EndDatestring, nullProbable
Date status ended. If this is null, the status is current.
- CommentsArray of object
Free text comments about the observation.
- Textstring, nullReliable
The plain text comment.
- VitalSignsTextstring, nullProbable
Free text form of the vital signs summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup. - VitalSignsArray of object
An array of groups of vital signs.
- DateTimestring, nullPossible
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. - ObservationsArray of object
An array of individual vital sign Observations[].
- Codestring, nullReliable
A code describing the type of vital sign being read (height, weight, blood pressure, etc.).
LOINC (HITSP Vital Sign Result Type). - CodeSystemstring, nullReliable
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. - CodeSystemNamestring, nullReliable
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. - Namestring, nullReliable
Name of the type of vital sign being read (height, weight, blood pressure, etc.)
- AltCodesArray of object
Alternate or translation codes for the type of vital sign being read (height, weight, blood pressure, etc.)
- Codestring, nullPossible
A code describing the type of vital sign being read (height, weight, blood pressure, etc.)
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the type of vital sign being read (height, weight, blood pressure, etc.)
- Statusstring, nullReliable
The status of the reading (usually completed)
- Interpretationstring, nullProbable
A flag indicating whether or not the observed value is normal, high, or low.
Supported Values - DateTimestring, nullReliable
The date/time when the specific vital sign was recorded.
ISO 8601 Format - Valuestring, nullReliable
The measurement recorded for the vital sign.
- Unitsstring, nullReliable
The units of the measurement.
UCUM Units of Measure - TargetSiteobject
- Codestring, nullProbable
A code describing the location on the body where the procedure was performed.
SNOMED CT - CodeSystemstring, nullProbable
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. - CodeSystemNamestring, nullProbable
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. - Namestring, nullProbable
Name of the location on the body where the procedure was performed
- AltCodesArray of object
Alternate or translation codes for the location on the body where the procedure was performed
- Codestring, nullPossible
A code describing the location on the body where the procedure was performed
- CodeSystemstring, nullPossible
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. - CodeSystemNamestring, nullPossible
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. - Namestring, nullPossible
Name of the location on the body where the procedure was performed
- CommentsArray of object
Free text comments about the vital sign.
- Textstring, nullReliable
The plain text comment.