ClinicalSummary
A Clinical Summary represents a snapshot of the patient's chart at a moment in time. It is structured in sections, each focusing on a different aspect of the patient's chart, such as allergies, immunizations, and medications. The full list of sections is on the left.
PatientQuery finds and returns the most recent Clinical Summary for a given patient at the specified health system. Include the fields listed in the PatientQuery section in the body of your request. The response will contain the sections from Header through Vital Signs.
You must provide the patient's medical record number (MRN) as part of the query. The ID type that corresponds to the MRN varies per health system. You should work with the health system to determine which ID type to send. If you do not already have a patient's MRN on file, you can obtain it using the PatientSearch data model. For testing purposes, the Redox Health System is connected to the NIST Document Sharing Test Facility, which uses the "NIST" ID type for the MRN. The PatientSearch data model will return a NIST ID that you should use with PatientQuery.
Fields
Meta
Meta.DataModel
String
ReliableRequiredClinical Summary
Meta.EventType
String
ReliableRequiredPatientQuery
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
Meta.FacilityCode
String
PossibleCode 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.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and IDTypes for the patient
Patient.Identifiers[].ID
String
ReliableRequiredID of the Patient
Patient.Identifiers[].IDType
String
ReliableRequiredID Type for the corresponding ID of this patient (ie. MRN, EHRID)
Location
Location.Department
String
PossibleID corresponding to the department from which to retrieved the patient chart.
This field is required for some EHRs.
{
"Meta": {
"DataModel": "Clinical Summary",
"EventType": "PatientQuery",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"Test": true,
"Destinations": [
{
"ID": "ef9e7448-7f65-4432-aa96-059647e9b357",
"Name": "Patient Query Endpoint"
}
],
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
]
},
"Location": {
"Department": null
}
}
This is the format of the response you will receive for PatientQuery messages.
Fields
Meta
Meta.DataModel
String
ReliableRequiredClinical Summary
Meta.EventType
String
ReliableRequiredPatientQueryResponse
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
Meta.FacilityCode
String
PossibleCode 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.
Header
Header.Document
Object
ReliableAn object containing metadata about the document being pushed to the destination.
Header.Document.Author.ID
String
ReliableID of the Provider responsible for the document.
This ID is often required for Inpatient Visits.
Header.Document.Author.IDType
String
ReliableID type of the ID for the Provider responsible for the document
Header.Document.Author.Type
String
ReliableValueSetThe type of provider for this referral
-
Additional values may be added by Redox in the future.
-
Header.Document.Author.FirstName
String
PossibleFirst name of the Provider responsible for the document
Header.Document.Author.LastName
String
PossibleLast name of the Provider responsible for the document
Header.Document.Author.Credentials[]
Array of Strings
PossibleList of credentials for the Provider responsible for the document.
e.g. MD, PhD
Header.Document.Author.Address
Object
PossibleProvider's address
Header.Document.Author.Address.StreetAddress
String
PossibleStreet address
Header.Document.Author.Address.City
String
PossibleCity
Header.Document.Author.Address.State
String
PossibleState
Header.Document.Author.Address.ZIP
String
PossibleZIP
Header.Document.Author.Address.County
String
PossibleCounty
Header.Document.Author.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Header.Document.Author.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Header.Document.Author.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Header.Document.Author.Location
Object
PossibleProvider's location
Header.Document.Author.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Author.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Header.Document.Author.Location.Department
String
PossibleDepartment
Header.Document.Author.Location.Room
String
PossibleRoom.
Example: 136
Header.Document.ID
String
ReliableRequiredYour application's ID for the document
Header.Document.Locale
String
ReliableRequiredThe language of the document.
Header.Document.Title
String
ReliableRequiredThe title of the document.
Header.Document.DateTime
String
ReliableRequiredThe creation/publishing date/time of the document.
Header.Document.Type
String
ReliableThe type of document.
This field is slated to be deprecated in favor of Header.Document.TypeCode.Name
Header.Document.TypeCode.Code
String
ReliableA code describing the type of document.
LOINC Document Type
Header.Document.TypeCode.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Header.Document.TypeCode.CodeSystemName
String
ReliableCoding system to which the code belongs (LOINC preferred).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Header.Document.TypeCode.Name
String
ReliableName of the type of document.
Summarization of Episode Note, Progress Note, etc.
Header.Patient.Identifiers[]
String
ReliableAn array of identifiers for the patient.
Header.Patient.Identifiers[].ID
String
ReliableRequiredThe actual identifier for the patient.
Header.Patient.Identifiers[].IDType
String
ReliableRequiredAn ID type associated with identifier (Medical Record Number, etc.)
Header.Patient.Identifiers[].Type
String
ReliableIf present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.
Header.Patient.Demographics.FirstName
String
ReliableRequiredPatient's first name
Header.Patient.Demographics.LastName
String
ReliableRequiredPatient's last name
Header.Patient.Demographics.DOB
Date
ReliableRequiredPatient's date of birth.
In YYYY-MM-DD format
Header.Patient.Demographics.SSN
String
ReliablePatient SSN
Header.Patient.Demographics.Sex
String
ReliableValueSetRequiredPatient gender
-
Additional values may be added by Redox in the future.
-
Header.Patient.Demographics.Address.StreetAddress
String
Reliable
Header.Patient.Demographics.Address.City
String
Reliable
Header.Patient.Demographics.Address.State
String
Reliable
Header.Patient.Demographics.Address.County
String
Reliable
Header.Patient.Demographics.Address.Country
String
Reliable
Header.Patient.Demographics.Address.ZIP
String
Reliable
Header.Patient.Demographics.PhoneNumber.Home
String
Reliable
Header.Patient.Demographics.PhoneNumber.Mobile
String
Reliable
Header.Patient.Demographics.EmailAddresses[].Address
String
Reliable
Header.Patient.Demographics.Language
String
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Header.Patient.Demographics.Race
String
ReliableOne of the following: American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, White, Other Race'
Header.Patient.Demographics.Ethnicity
String
ReliableOne of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown
Header.Patient.Demographics.Religion
String
Reliable
Header.Patient.Demographics.MaritalStatus
String
ReliableValueSet
-
Additional values may be added by Redox in the future.
-
Header.PCP.ID
String
PossibleID of the Primary Care Provider for the Patient.
This ID is often required for Inpatient Visits.
Header.PCP.IDType
String
PossibleID type of the ID for the Primary Care Provider for the Patient
Header.PCP.Type
String
PossibleValueSetThe type of provider for this referral
-
Additional values may be added by Redox in the future.
-
Header.PCP.FirstName
String
PossibleFirst name of the Primary Care Provider for the Patient
Header.PCP.LastName
String
PossibleLast name of the Primary Care Provider for the Patient
Header.PCP.Credentials[]
Array of Strings
PossibleList of credentials for the Primary Care Provider for the Patient.
e.g. MD, PhD
Header.PCP.Address
Object
PossibleProvider's address
Header.PCP.Address.StreetAddress
String
PossibleStreet address
Header.PCP.Address.City
String
PossibleCity
Header.PCP.Address.State
String
PossibleState
Header.PCP.Address.ZIP
String
PossibleZIP
Header.PCP.Address.County
String
PossibleCounty
Header.PCP.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Header.PCP.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Header.PCP.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Header.PCP.Location
Object
PossibleProvider's location
Header.PCP.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.PCP.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Header.PCP.Location.Department
String
PossibleDepartment
Header.PCP.Location.Room
String
PossibleRoom.
Example: 136
AdvanceDirectives
AdvanceDirectivesText
String
ProbableFree text form of the advance directives summary
AdvanceDirectives[]
Array of Objects
Probable
AdvanceDirectives[].Type.Code
String
ReliableRequiredA code describing the type of advance directive (such as resuscitation).
SNOMED CT
AdvanceDirectives[].Type.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.Name
String
ReliableName of the type of advance directive (such as resuscitation)
AdvanceDirectives[].Type.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of advance directive (such as resuscitation)
AdvanceDirectives[].Type.AltCodes[].Code
String
PossibleA code describing the type of advance directive (such as resuscitation)
AdvanceDirectives[].Type.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.AltCodes[].Name
String
PossibleName of the type of advance directive (such as resuscitation)
AdvanceDirectives[].Code
String
ReliableRequiredA code describing the value of the advance directive (such as 'do not resuscitate').
SNOMED CT
AdvanceDirectives[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Name
String
ReliableName of the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].AltCodes[].Code
String
PossibleA code describing the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].AltCodes[].Name
String
PossibleName of the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].StartDate
DateTime
ReliableRequiredEffective start date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].EndDate
DateTime
ProbableEffective end date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].ExternalReference
String
ProbableA link to a location where the document can be accessed.
AdvanceDirectives[].VerifiedBy[]
Array of Objects
ProbableA collection of people who verified the advance directive with the patient
AdvanceDirectives[].VerifiedBy[].FirstName
String
Probable
AdvanceDirectives[].VerifiedBy[].LastName
String
Probable
AdvanceDirectives[].VerifiedBy[].Credentials
String
Probable
AdvanceDirectives[].VerifiedBy[].DateTime
String
Probable
AdvanceDirectives[].Custodians[]
Array of Objects
ProbablePeople legally resposible for the advance directive document.
AdvanceDirectives[].Custodians[].FirstName
String
Probable
AdvanceDirectives[].Custodians[].LastName
String
Probable
AdvanceDirectives[].Custodians[].Credentials
String
Probable
AdvanceDirectives[].Custodians[].Address.StreetAddress
String
Probable
AdvanceDirectives[].Custodians[].Address.City
String
Probable
AdvanceDirectives[].Custodians[].Address.State
String
Probable
AdvanceDirectives[].Custodians[].Address.Country
String
Probable
AdvanceDirectives[].Custodians[].Address.ZIP
String
Probable
Allergies
AllergyText
String
ReliableFree text form of the allergies summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Allergies[]
Array of Objects
Probable
Allergies[].Type.Code
String
ReliableRequiredA code describing the type of allergy intolerance this is (food, drug, etc.).
SNOMED CT from Allergy/Adverse Event Type Value Set
Allergies[].Type.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.Name
String
ReliableName of the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Type.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Type.AltCodes[].Code
String
PossibleA code describing the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Type.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.AltCodes[].Name
String
PossibleName of the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Substance.Code
String
ReliableRequired
Allergies[].Substance.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.Name
String
ReliableName of the substance that the causes the alergy/intolerance
Allergies[].Substance.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the substance that the causes the alergy/intolerance
Allergies[].Substance.AltCodes[].Code
String
PossibleA code describing the substance that the causes the alergy/intolerance
Allergies[].Substance.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.AltCodes[].Name
String
PossibleName of the substance that the causes the alergy/intolerance
Allergies[].Reaction[]
String
ProbableAll the reactions caused by this particular substance.
SNOMED CT
Allergies[].Reaction[].Code
String
ReliableRequiredA code describing the reaction caused by the allergy (dizziness, hives ,etc.).
SNOMED CT
Allergies[].Reaction[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].Name
String
ReliableName of the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].AltCodes[].Code
String
PossibleA code describing the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].AltCodes[].Name
String
PossibleName of the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].Severity.Code
String
ReliableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT
Allergies[].Reaction[].Severity.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].Severity.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].Severity.Name
String
ReliableName of a code for the severity of the reaction (moderate, severe, etc.)
Allergies[].Reaction[].Text
String
ReliableFree text form of reactions to this substance, includes information that cannot be captured by coded value.
Allergies[].Severity.Code
String
PossibleA 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.
Allergies[].Severity.CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Severity.CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Severity.Name
String
PossibleName of a code for the severity of the reaction (moderate, severe, etc.).
Allergies[].Criticality.Code
String
PossibleA 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.
Allergies[].Criticality.CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Criticality.CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Criticality.Name
String
PossibleName of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
Allergies[].Status.Code
String
ReliableRequiredA code describing the current status of the allergy (active, historic, etc.).
SNOMED CT (Active, Inactive, Resolved)
Allergies[].Status.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Status.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Status.Name
String
ReliableName of the current status of the allergy (active, historic, etc.)
Allergies[].StartDate
String
ProbableWhen the allergy was first noted.
ISO 8601 Format
Allergies[].EndDate
String
ProbableWhen the allergy was no longer a problem (if applicable).
ISO 8601 Format
Allergies[].Comment
String
PossibleFree text comment about the allergy.
Encounters
EncountersText
String
ProbableFree text form of the encounters summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Encounters[]
Array of Objects
Probable
Encounters[].Identifiers[]
Array of Objects
ProbableList of IDs specific to this encounter
Encounters[].Identifiers[].ID
String
ProbableAn ID specific to this encounter
Encounters[].Identifiers[].IDType
String
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Encounters[].Type.Code
String
ReliableRequiredA code describing the type of encounter (office visit, hospital, etc).
CPT-4
Encounters[].Type.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.Name
String
ReliableName of the type of encounter (office visit, hospital, etc)
Encounters[].Type.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of encounter (office visit, hospital, etc)
Encounters[].Type.AltCodes[].Code
String
PossibleA code describing the type of encounter (office visit, hospital, etc)
Encounters[].Type.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.AltCodes[].Name
String
PossibleName of the type of encounter (office visit, hospital, etc)
Encounters[].DateTime
DateTime
ReliableRequiredWhen the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present.
ISO 8601 Format
Encounters[].EndDateTime
DateTime
PossibleWhen the encounter was completed, if available.
ISO 8601 Format
Encounters[].Providers[].ID
String
ProbableID of the Encounter Providers.
This ID is often required for Inpatient Visits.
Encounters[].Providers[].IDType
String
ProbableID type of the ID for the Encounter Providers
Encounters[].Providers[].FirstName
String
PossibleFirst name of the Encounter Providers
Encounters[].Providers[].LastName
String
PossibleLast name of the Encounter Providers
Encounters[].Providers[].Credentials[]
Array of Strings
PossibleList of credentials for the Encounter Providers.
e.g. MD, PhD
Encounters[].Providers[].Address
Object
PossibleProvider's address
Encounters[].Providers[].Address.StreetAddress
String
PossibleStreet address
Encounters[].Providers[].Address.City
String
PossibleCity
Encounters[].Providers[].Address.State
String
PossibleState
Encounters[].Providers[].Address.ZIP
String
PossibleZIP
Encounters[].Providers[].Address.County
String
PossibleCounty
Encounters[].Providers[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Encounters[].Providers[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Encounters[].Providers[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Encounters[].Providers[].Location
Object
PossibleProvider's location
Encounters[].Providers[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Encounters[].Providers[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Encounters[].Providers[].Location.Department
String
PossibleDepartment
Encounters[].Providers[].Location.Room
String
PossibleRoom.
Example: 136
Encounters[].Providers[].Role.Code
String
ProbableA code describing the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.Name
String
ProbableName of the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.AltCodes[].Code
String
PossibleA code describing the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.AltCodes[].Name
String
PossibleName of the role of the provider (pcp, general physician, etc.)
Encounters[].Locations[]
String
Probable
Encounters[].Locations[].Address.StreetAddress
String
Probable
Encounters[].Locations[].Address.City
String
Probable
Encounters[].Locations[].Address.State
String
Probable
Encounters[].Locations[].Address.Country
String
Probable
Encounters[].Locations[].Address.ZIP
String
Probable
Encounters[].Locations[].Type.Code
String
ProbableA code describing the type of location where the patient was seen (clinic, urgent care, hostpital).
Heathcare Service Location
Encounters[].Locations[].Type.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.Name
String
ProbableName of the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].Type.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].Type.AltCodes[].Code
String
PossibleA code describing the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].Type.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.AltCodes[].Name
String
PossibleName of the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].Name
String
ProbableThe name of the location
Encounters[].Diagnosis[]
String
ProbableList of Diagnoses associated with the visit.
SNOMED CT
Encounters[].Diagnosis[].Code
String
ProbableA code describing the associated diagnosis
Encounters[].Diagnosis[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].Name
String
ProbableName of the associated diagnosis
Encounters[].Diagnosis[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the associated diagnosis
Encounters[].Diagnosis[].AltCodes[].Code
String
PossibleA code describing the associated diagnosis
Encounters[].Diagnosis[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].AltCodes[].Name
String
PossibleName of the associated diagnosis
Encounters[].ReasonForVisit[].Code
String
ProbableA code describing the reason for the visit (usually this is what the patient reports).
SNOMED CT
Encounters[].ReasonForVisit[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].Name
String
ProbableName of the reason for the visit (usually this is what the patient reports)
Encounters[].ReasonForVisit[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the reason for the visit (usually this is what the patient reports)
Encounters[].ReasonForVisit[].AltCodes[].Code
String
PossibleA code describing the reason for the visit (usually this is what the patient reports)
Encounters[].ReasonForVisit[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].AltCodes[].Name
String
PossibleName of the reason for the visit (usually this is what the patient reports)
FamilyHistory
FamilyHistoryText
String
ProbableFree text form of the family history summary
FamilyHistory[]
Array of Objects
ProbableEach element of the FamilyHistory is one person in the patient's family.
FamilyHistory[].Relation.Code
String
ReliableRequiredA code describing the family member's relationship (father, mother, maternal grandfather, etc.).
HL7 Family History Related Subjects
FamilyHistory[].Relation.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Relation.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Relation.Name
String
ReliableName of the family member's relationship (father, mother, maternal grandfather, etc.)
FamilyHistory[].Relation.Demographics.Sex
String
ProbableValueSetGender of the relative
-
Additional values may be added by Redox in the future.
-
FamilyHistory[].Relation.Demographics.DOB
String
ProbableDate of Birth of the relative.
In YYYY-MM-DD format
FamilyHistory[].Relation.IsDeceased
Boolean
ProbableWhether or not the relative is deceased
FamilyHistory[].Problems[]
String
ReliableA list of the relative's relevant health problems
FamilyHistory[].Problems[].Code
String
ReliableRequiredA code describing a particular problem experienced by the relative.
SNOMED CT
FamilyHistory[].Problems[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].Name
String
ReliableName of a particular problem experienced by the relative
FamilyHistory[].Problems[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for a particular problem experienced by the relative
FamilyHistory[].Problems[].AltCodes[].Code
String
PossibleA code describing a particular problem experienced by the relative
FamilyHistory[].Problems[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].AltCodes[].Name
String
PossibleName of a particular problem experienced by the relative
FamilyHistory[].Problems[].Type.Code
String
ReliableRequiredA code describing the general class of the problem. (disease, problem, etc.).
Problem Type Value Set
FamilyHistory[].Problems[].Type.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].Type.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].Type.Name
String
ReliableName of the general class of the problem. (disease, problem, etc.)
FamilyHistory[].Problems[].DateTime
String
ProbableThe time when the problem started.
ISO 8601 Format
FamilyHistory[].Problems[].AgeAtOnset
String
ProbableThe relative's age when the problem started
FamilyHistory[].Problems[].IsCauseOfDeath
Boolean
ProbableFlag indicating whether or not this problem was the cause of death for the relative.
Immunizations
ImmunizationText
String
ProbableFree text form of the immunization summary
Immunizations[]
Array of Objects
ReliableArray of immunizations for patient.
Immunizations[].DateTime
String
ReliableRequiredWhen the immunization was given.
ISO 8601 Format
Immunizations[].Route.Code
String
ProbableA code describing the way in which the immunization was delivered (intramuscular, oral, etc.).
Medication Route FDA Value Set
Immunizations[].Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.Name
String
ProbableName of the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Route.AltCodes[].Code
String
PossibleA code describing the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.AltCodes[].Name
String
PossibleName of the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Product.Manufacturer
String
ProbableName of organization that manufacture the immunization.
Free text
Immunizations[].Product.Code
String
ReliableRequiredA code describing the vaccination that was given.
CVX code system
Immunizations[].Product.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.Name
String
ReliableName of the vaccination that was given
Immunizations[].Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the vaccination that was given
Immunizations[].Product.AltCodes[].Code
String
PossibleA code describing the vaccination that was given
Immunizations[].Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.AltCodes[].Name
String
PossibleName of the vaccination that was given
Immunizations[].Product.LotNumber
String
ProbableThe lot number of the vaccine
Immunizations[].Dose.Quantity
String
ProbableThe size of the dose
Immunizations[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Insurances
InsurancesText
String
PossibleFree text form of the patient's insurances.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Insurances[]
Array of Objects
PossibleList of insurance coverages for the patient
Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Insurances[].Plan.Name
String
ProbableName of insurance plan
Insurances[].Plan.Type
String
PossibleType of insurance plan
Insurances[].MemberNumber
String
PossiblePatient member number
Insurances[].Company.ID
String
PossibleID of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.IDType
String
PossibleID type of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Insurances[].Company.Address
Object
ProbableInsurance company's address
Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Insurances[].Company.Address.City
String
ProbableCity
Insurances[].Company.Address.State
String
ProbableState
Insurances[].Company.Address.ZIP
String
ProbableZIP
Insurances[].Company.Address.County
String
PossibleCounty
Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Insurances[].GroupNumber
String
ProbableInsurance policy group number
Insurances[].GroupName
String
PossibleInsurance policy group name.
Typically not available in ClinicalSummary.
Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Insurances[].PolicyNumber
String
ProbableInsurance policy number
Insurances[].AgreementType
String
PossibleType of insurance agreement.
Typically not available in ClinicalSummary.
Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Insurances[].Insured.LastName
String
PossibleLast name of the insured
Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Insurances[].Insured.SSN
String
PossibleInsured's social security number
Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.Address
Object
ProbableAddress of the insured
Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Insurances[].Insured.Address.City
String
ProbableCity
Insurances[].Insured.Address.State
String
ProbableState
Insurances[].Insured.Address.ZIP
String
ProbableZIP
Insurances[].Insured.Address.County
String
PossibleCounty
Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
MedicalEquipment
MedicalEquipmentText
String
ProbableFree text form of the medical equipment summary
MedicalEquipment[]
String
ProbableA list of medical equipment that the patient uses (cane, pacemakers, etc.)
MedicalEquipment[].Status
String
ReliableRequiredThe current status of the equipment (active, completed, etc.)
MedicalEquipment[].StartDate
String
ProbableWhen the equipment was first put into use.
ISO 8601 Format
MedicalEquipment[].Quantity
String
ProbableThe number of products used
MedicalEquipment[].Product.Code
String
ProbableA code describing the actual product.
SNOMED CT
MedicalEquipment[].Product.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.Name
String
ProbableName of the actual product.
MedicalEquipment[].Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual product.
MedicalEquipment[].Product.AltCodes[].Code
String
PossibleA code describing the actual product.
MedicalEquipment[].Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.AltCodes[].Name
String
PossibleName of the actual product.
Medications
MedicationsText
String
ReliableFree text form of the medications summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Medications[]
Array of Objects
Probable
Medications[].Prescription
Boolean
ReliableRequiredWhether the medication is a prescription.
For a prescription: true. For a patient reported med, or a med administered by a provider: false
Medications[].FreeTextSig
String
PossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
Medications[].Dose.Quantity
String
ProbableThe size of the dose for pills, capsules, etc.
Medications[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Medications[].Rate.Quantity
String
ProbableIf the medication is in liquid form, the rate at which it is administered
Medications[].Rate.Units
String
ProbableUnits for the rate.
UCUM Units of Measure
Medications[].Route.Code
String
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
Medications[].Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.Name
String
ProbableName of the method by which the medication is delivered
Medications[].Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the method by which the medication is delivered
Medications[].Route.AltCodes[].Code
String
PossibleA code describing the method by which the medication is delivered
Medications[].Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.AltCodes[].Name
String
PossibleName of the method by which the medication is delivered
Medications[].StartDate
String
ReliableRequiredWhen the medication was started.
ISO 8601 Format
Medications[].EndDate
String
ProbableWhen the medication ended.
ISO 8601 Format
Medications[].Frequency.Period
String
ProbableHow often the patient should be taking the medication.
UCUM Units of Measure
Medications[].Frequency.Unit
String
ProbableUnits for how often the patient should be taking the medication
Medications[].IsPRN
Boolean
ProbableWhether the medication is to be taken on an as-needed basis
Medications[].Product.Code
String
ReliableRequiredA code describing the actual medication given .
RxNorm
Medications[].Product.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.Name
String
ReliableName of the actual medication given
Medications[].Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual medication given
Medications[].Product.AltCodes[].Code
String
PossibleA code describing the actual medication given
Medications[].Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.AltCodes[].Name
String
PossibleName of the actual medication given
PlanOfCare
PlanOfCareText
String
ProbableFree text form of the plan of care summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
PlanOfCare.Orders[]
Array of Objects
ProbableFuture lab tests or other diagnostic procedures.
PlanOfCare.Orders[].Code
String
ProbableA code describing the test to be performed .
LOINC
PlanOfCare.Orders[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].Name
String
ProbableName of the test to be performed
PlanOfCare.Orders[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the test to be performed
PlanOfCare.Orders[].AltCodes[].Code
String
PossibleA code describing the test to be performed
PlanOfCare.Orders[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].AltCodes[].Name
String
PossibleName of the test to be performed
PlanOfCare.Orders[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Orders[].DateTime
ISO Format
Probable
PlanOfCare.Procedures[]
Array of Objects
ProbableFuture procedures.
PlanOfCare.Procedures[].Code
String
ProbableA code describing the planned procedure, such as an appendectomy or hip replacement .
SNOMED CT
PlanOfCare.Procedures[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].Name
String
ProbableName of the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].AltCodes[].Code
String
PossibleA code describing the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].AltCodes[].Name
String
PossibleName of the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Procedures[].DateTime
ISO Format
Probable
PlanOfCare.Encounters[]
Array of Objects
ProbableAppointments and other upcoming encounters
PlanOfCare.Encounters[].Code
String
ProbableA code describing the planned encounter type .
SNOMED CT
PlanOfCare.Encounters[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].Name
String
ProbableName of the planned encounter type
PlanOfCare.Encounters[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned encounter type
PlanOfCare.Encounters[].AltCodes[].Code
String
PossibleA code describing the planned encounter type
PlanOfCare.Encounters[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].AltCodes[].Name
String
PossibleName of the planned encounter type
PlanOfCare.Encounters[].Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identifies the encounter
PlanOfCare.Encounters[].Identifiers[].ID
String
PossibleID for the encounter
PlanOfCare.Encounters[].Identifiers[].IDType
String
PossibleType of ID
PlanOfCare.Encounters[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Encounters[].DateTime
String
Probable
PlanOfCare.MedicationAdministration[]
Array of Objects
ProbablePlanned medication
PlanOfCare.MedicationAdministration[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.MedicationAdministration[].Dose.Quantity
String
ProbableThe size of the dose for pills, capsules, etc.
PlanOfCare.MedicationAdministration[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Rate.Quantity
String
ProbableIf the medication is not in does form, this is the rate at which is administered
PlanOfCare.MedicationAdministration[].Rate.Units
String
ProbableUnits for the rate.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Route.Code
String
ProbableA code describing the method by which the medication is to be delivered.
Medication Route FDA Value Set
PlanOfCare.MedicationAdministration[].Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.Name
String
ProbableName of the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].Route.AltCodes[].Code
String
PossibleA code describing the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.AltCodes[].Name
String
PossibleName of the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].StartDate
ISO Format
ProbableWhen the medication was started
PlanOfCare.MedicationAdministration[].EndDate
ISO Format
ProbableWhen the medication ended
PlanOfCare.MedicationAdministration[].Frequency.Period
String
ProbableHow often the patient should be taking the medication.
UCUM Units of measure
PlanOfCare.MedicationAdministration[].Frequency.Unit
String
ProbableUnits for how often the patient should be taking the medication
PlanOfCare.MedicationAdministration[].Product.Code
String
ProbableA code describing the planned medication .
RxNorm
PlanOfCare.MedicationAdministration[].Product.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.Name
String
ProbableName of the planned medication
PlanOfCare.MedicationAdministration[].Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned medication
PlanOfCare.MedicationAdministration[].Product.AltCodes[].Code
String
PossibleA code describing the planned medication
PlanOfCare.MedicationAdministration[].Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.AltCodes[].Name
String
PossibleName of the planned medication
PlanOfCare.Supplies[]
Array of Objects
ProbableFuture supplies that a patient may be given, including implants.
PlanOfCare.Supplies[].Code
String
ProbableA code describing the planned product.
SNOMED CT
PlanOfCare.Supplies[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].Name
String
ProbableName of the planned product
PlanOfCare.Supplies[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned product
PlanOfCare.Supplies[].AltCodes[].Code
String
PossibleA code describing the planned product
PlanOfCare.Supplies[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].AltCodes[].Name
String
PossibleName of the planned product
PlanOfCare.Supplies[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Supplies[].DateTime
ISO Format
ProbableThe scheduled time of the activity. .
ISO 8601 Format
PlanOfCare.Services[]
Array of Objects
ProbablePlanned activities that are service-oriented in nature, such as a dressing change, or feeding a patient.
PlanOfCare.Services[].Code
String
ProbableA code describing the planned activity.
SNOMED CT
PlanOfCare.Services[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].Name
String
ProbableName of the planned activity.
PlanOfCare.Services[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned activity.
PlanOfCare.Services[].AltCodes[].Code
String
PossibleA code describing the planned activity.
PlanOfCare.Services[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].AltCodes[].Name
String
PossibleName of the planned activity.
PlanOfCare.Services[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Services[].DateTime
ISO Format
ProbableThe scheduled time of the activity. .
ISO 8601 Format
Problems
ProblemsText
String
ReliableFree text form of the problems summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Problems[]
Array of Objects
ReliableAn array of all of patient relevant problems, current and historical.
Problems[].StartDate
String
ProbableWhen the problem was noticed.
ISO 8601 Format
Problems[].EndDate
String
ProbableWhen the problem stopped (if it is not current).
ISO 8601 Format
Problems[].Code
String
ReliableRequiredA code describing the actual problem .
SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009)
Problems[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Name
String
ReliableName of the actual problem
Problems[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual problem
Problems[].AltCodes[].Code
String
PossibleA code describing the actual problem
Problems[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].AltCodes[].Name
String
PossibleName of the actual problem
Problems[].Category.Code
String
ReliableRequiredA code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.Name
String
ReliableName of the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.AltCodes[].Code
String
PossibleA code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.AltCodes[].Name
String
PossibleName of the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].HealthStatus.Code
String
ProbableA code describing the effect of the problem on the patient (chronically ill, in remission, etc.).
SNOMED-CT
Problems[].HealthStatus.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.Name
String
ProbableName of the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].HealthStatus.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].HealthStatus.AltCodes[].Code
String
PossibleA code describing the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].HealthStatus.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.AltCodes[].Name
String
PossibleName of the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].Status.Code
String
ProbableA code describing the current state of the problem (active, inactive, resolved).
HITSPProblemStatus
Problems[].Status.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Status.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Status.Name
String
ProbableName of the current state of the problem (active, inactive, resolved)
Problems[].Comment
String
PossibleFree text comment about the problem
Procedures
ProceduresText
String
ProbableFree text form of the procedures summary
Procedures
ProbableA 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.
Procedures.Observations[]
ProbableThese are procedures that are more observational in nature, such as an EEG or EKG.
Procedures.Observations[].Code
String
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Observations[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].Name
String
ProbableName of the procedure that was performed.
Procedures.Observations[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the procedure that was performed.
Procedures.Observations[].AltCodes[].Code
String
PossibleA code describing the procedure that was performed.
Procedures.Observations[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].AltCodes[].Name
String
PossibleName of the procedure that was performed.
Procedures.Observations[].DateTime
ProbableWhen the procedure was performed.
Procedures.Observations[].Status
ProbableThe status of the procedure.
Procedures.Observations[].TargetSite.Code
String
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Observations[].TargetSite.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.Name
String
ProbableName of the location on the body where the procedure was performed
Procedures.Observations[].TargetSite.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the location on the body where the procedure was performed
Procedures.Observations[].TargetSite.AltCodes[].Code
String
PossibleA code describing the location on the body where the procedure was performed
Procedures.Observations[].TargetSite.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.AltCodes[].Name
String
PossibleName of the location on the body where the procedure was performed
Procedures.Procedures[]
ProbableThese are procedures that alter the state of the body, such as an appendectomy or hip replacement.
Procedures.Procedures[].Code
String
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Procedures[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].Name
String
ProbableName of the procedure that was performed.
Procedures.Procedures[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the procedure that was performed.
Procedures.Procedures[].AltCodes[].Code
String
PossibleA code describing the procedure that was performed.
Procedures.Procedures[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].AltCodes[].Name
String
PossibleName of the procedure that was performed.
Procedures.Procedures[].DateTime
ProbableWhen the procedure was performed.
Procedures.Procedures[].Status
ProbableThe status of the procedure.
Procedures.Procedures[].TargetSite.Code
String
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Procedures[].TargetSite.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.Name
String
ProbableName of the location on the body where the procedure was performed
Procedures.Procedures[].TargetSite.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the location on the body where the procedure was performed
Procedures.Procedures[].TargetSite.AltCodes[].Code
String
PossibleA code describing the location on the body where the procedure was performed
Procedures.Procedures[].TargetSite.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.AltCodes[].Name
String
PossibleName of the location on the body where the procedure was performed
Procedures.Services[]
ProbableThese are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient.
Procedures.Services[].Code
String
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Services[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].Name
String
ProbableName of the procedure that was performed.
Procedures.Services[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the procedure that was performed.
Procedures.Services[].AltCodes[].Code
String
PossibleA code describing the procedure that was performed.
Procedures.Services[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].AltCodes[].Name
String
PossibleName of the procedure that was performed.
Procedures.Services[].DateTime
ProbableWhen the procedure was performed.
Procedures.Services[].Status
ProbableThe status of the procedure.
Results
ResultText
String
ReliableFree text form of the results summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Results[]
ProbableArray of test results for the patient. This can include laboratory results, imaging results, and procedure results.
Results[].Code
String
ReliableRequiredA code describing the test performed and resulted.
LOINC for Lab, SNOMED CT otherwise
Results[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Name
String
ReliableName of the test performed and resulted.
Results[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the test performed and resulted.
Results[].AltCodes[].Code
String
PossibleA code describing the test performed and resulted.
Results[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].AltCodes[].Name
String
PossibleName of the test performed and resulted.
Results[].Status
String
ReliableRequiredThe status of the test (In Progress, Final)
Results[].Producer.ID
String
PossibleID of the producer for this result.
The "Producer" is typically the Lab which did the resulting.
Results[].Producer.Name
String
PossibleName of the producer
Results[].Producer.IDType
String
PossibleID Type for the corresponding ID of this producer
Results[].Producer.Address
Object
PossibleResult producer's address
Results[].Producer.Address.StreetAddress
String
PossibleStreet address
Results[].Producer.Address.City
String
PossibleCity
Results[].Producer.Address.State
String
PossibleState
Results[].Producer.Address.ZIP
String
PossibleZIP
Results[].Producer.Address.County
String
PossibleCounty
Results[].Producer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Results[].Observations[]
Array of Object
ReliableA list of corresponding observations for the test (result components)
Results[].Observations[].Code
String
ReliableRequiredA code describing the individual result component. .
LOINC for Lab, SNOMED CT otherwise
Results[].Observations[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].Name
String
ReliableName of the individual result component.
Results[].Observations[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the individual result component.
Results[].Observations[].AltCodes[].Code
String
PossibleA code describing the individual result component.
Results[].Observations[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].AltCodes[].Name
String
PossibleName of the individual result component.
Results[].Observations[].Status
String
ReliableRequiredThe status of the individual component. Some tests may have different components finish at different times. .
One of (In Progress, Final)
Results[].Observations[].Interpretation
String
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
Results[].Observations[].DateTime
String
ReliableRequiredA specific date/time when the value was recorded.
ISO 8601 Format
Results[].Observations[].CodedValue.Code
String
PossibleA 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
Results[].Observations[].CodedValue.CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.Name
String
PossibleName of the individual result value.
Results[].Observations[].CodedValue.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the individual result value.
Results[].Observations[].CodedValue.AltCodes[].Code
String
PossibleA code describing the individual result value.
Results[].Observations[].CodedValue.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.AltCodes[].Name
String
PossibleName of the individual result value.
Results[].Observations[].Value
String
ReliableRequiredThe measurement recorded for the result.
Results[].Observations[].ValueType
String
ReliableThe type and format of the value.
One of the following: PhysicalQuantity, String, Number, Interval, Ratio, Code. Intervals will be represented in Value as low-high, <low, <=low, >high, or >=high. Ratios will be represented in Value as numerator:denominator.
Results[].Observations[].Units
String
ReliableRequiredThe units of the measurement.
Only available when ValueType is PhysicalQuantity
Results[].Observations[].ReferenceRange
Object
PossibleReference 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.
Results[].Observations[].ReferenceRange.Low
Numeric
PossibleLower bound for a normal result
Results[].Observations[].ReferenceRange.High
Numeric
PossibleUpper bound for a normal result
Results[].Observations[].ReferenceRange.Text
String
PossibleThe normal value for non-numeric results
SocialHistory
SocialHistoryText
String
ProbableFree text form of the social history summary
SocialHistory.Observations[]
String
ProbableGeneric observations about the patient's social hisotry that don't fall into the smoking or pregnancy categories.
SocialHistory.Observations[].Code
String
ProbableA code describing a type of social history observation (exercise, alcohol intake, etc.) .
SNOMED CT
SocialHistory.Observations[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Name
String
ProbableName of a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].AltCodes[].Code
String
PossibleA code describing a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].AltCodes[].Name
String
PossibleName of a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].Value
Object
ProbableThe observed value
SocialHistory.Observations[].Value.Code
String
ProbableA code describing the observed value, if coded
SocialHistory.Observations[].Value.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.Name
String
ProbableName of the observed value, if coded
SocialHistory.Observations[].Value.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the observed value, if coded
SocialHistory.Observations[].Value.AltCodes[].Code
String
PossibleA code describing the observed value, if coded
SocialHistory.Observations[].Value.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.AltCodes[].Name
String
PossibleName of the observed value, if coded
SocialHistory.Observations[].ValueText
String
ProbableThe observed value, if uncoded
SocialHistory.Observations[].StartDate
String
ProbableStart date of status
SocialHistory.Observations[].EndDate
String
ProbableDate status ended. If this is null, the status is current.
SocialHistory.Pregnancy[]
String
ProbableInformation about past and current pregnancies.
SocialHistory.Pregnancy[].StartDate
String
ProbableWhen the pregnancy started.
ISO 8601 Format
SocialHistory.Pregnancy[].EndDate
String
ProbableWhen the pregnancy ended.
ISO 8601 Format
SocialHistory.Pregnancy[].EstimatedDelivery
String
ProbableEstimate delivery date if pregnancy is still active.
SocialHistory.TobaccoUse[]
String
ProbableContains tobacco use and smoking status observations
SocialHistory.TobaccoUse[].Code
String
ProbableA 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
SocialHistory.TobaccoUse[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].Name
String
ProbableName of the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].AltCodes[].Code
String
PossibleA code describing the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].AltCodes[].Name
String
PossibleName of the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].IsSmokingStatus
Boolean
ProbableIdentifies this tobacco use entry as a smoking status.
If true, StartDate is the date the smoking status was observed.
SocialHistory.TobaccoUse[].StartDate
String
ProbableStart date of status.
If IsSmokingStatus is true, this is the date the observation was made.
SocialHistory.TobaccoUse[].EndDate
String
ProbableDate status ended. If this is null, the status is current.
VitalSigns
VitalSignsText
String
ProbableFree text form of the vital signs summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
VitalSigns[]
String
ProbableAn array of groups of vital signs.
VitalSigns[].DateTime
String
PossibleThe 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.
VitalSigns[].Observations[]
String
ReliableAn array of individual vital sign Observations[].
VitalSigns[].Observations[].Code
String
ReliableRequiredA code describing the type of vital sign being read (height, weight, blood pressure, etc.).
LOINC (HITSP Vital Sign Result Type).
VitalSigns[].Observations[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].Name
String
ReliableName of the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].AltCodes[].Code
String
PossibleA code describing the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].AltCodes[].Name
String
PossibleName of the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].Status
String
ReliableRequiredThe status of the reading (usually completed)
VitalSigns[].Observations[].Interpretation
String
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
VitalSigns[].Observations[].DateTime
String
ReliableRequiredThe date/time when the specific vital sign was recorded.
ISO 8601 Format
VitalSigns[].Observations[].Value
String
ReliableRequiredThe measurement recorded for the vital sign.
VitalSigns[].Observations[].Units
String
ReliableRequiredThe units of the measurement.
UCUM Units of Measure
{
"Meta": {
"DataModel": "Clinical Summary",
"EventType": "PatientQueryResponse",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "ef9e7448-7f65-4432-aa96-059647e9b358",
"Name": "Patient Query Endpoint"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Header": {
"Document": {
"Author": {
"ID": "4356789876",
"IDType": "NPI",
"Type": null,
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ID": "75cb4ad4-e5f9-4cd3-8750-eb5050521e0d",
"Locale": "US",
"Title": "Community Health and Hospitals: Health Summary",
"DateTime": "2012-09-12T00:00:00.000Z",
"Type": "Summarization of Episode Note",
"TypeCode": {
"Code": "34133-9",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Summarization of Episode Note"
}
},
"Patient": {
"Identifiers": [
{
"ID": "1234",
"IDType": "2.16.840.1.113883.4.6",
"Type": null
}
],
"Demographics": {
"FirstName": "Myra",
"LastName": "Jones",
"DOB": "1947-05-01",
"SSN": "123-101-1234",
"Sex": "Female",
"Address": {
"StreetAddress": "1357 Amber Drive",
"City": "Beaverton",
"State": "OR",
"County": null,
"Country": "US",
"ZIP": "97006"
},
"PhoneNumber": {
"Home": "+18162766909",
"Mobile": null
},
"EmailAddresses": [
{
"Address": "[email protected]"
}
],
"Language": null,
"Race": "White",
"Ethnicity": "Not Hispanic or Latino",
"Religion": "Christian (non-Catholic, non-specific)",
"MaritalStatus": "Married"
}
},
"PCP": {
"ID": null,
"IDType": null,
"Type": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
},
"AdvanceDirectivesText": "<table width=\"100%\"><thead><tr><th>Directive</th><th>Description</th><th>Verification</th><th>Supporting Document(s)</th></tr></thead><tbody><tr><td>Resuscitation status</td><td ID=\"AD1\">Do not resuscitate</td><td>Dr. Robert Dolin, Nov 07, 1999</td><td><linkHtml href=\"AdvanceDirective.b50b7910-7ffb-4f4c-bbe4-177ed68cbbf3.pdf\">Advance directive</linkHtml></td></tr></tbody></table>",
"AdvanceDirectives": [
{
"Type": {
"Code": "304251008",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Resuscitation",
"AltCodes": []
},
"Code": "304253006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Do not resuscitate",
"AltCodes": [],
"StartDate": "2011-02-13T05:00:00.000Z",
"EndDate": null,
"ExternalReference": "AdvanceDirective.b50b7910-7ffb-4f4c-bbe4-177ed68cbbf3.pdf",
"VerifiedBy": [
{
"FirstName": "Robert",
"LastName": "Dolin",
"Credentials": "Dr.",
"DateTime": null
}
],
"Custodians": [
{
"FirstName": "Robert",
"LastName": "Dolin",
"Credentials": "Dr.",
"Address": {
"StreetAddress": "21 North Ave.",
"City": "Burlington",
"State": "MA",
"Country": "USA",
"ZIP": "02368"
}
}
]
}
],
"AllergyText": "<table width=\"100%\"><thead><tr><th>Substance</th><th>Reaction</th><th>Severity</th><th>Status</th></tr></thead><tbody><tr><td>Penicillin G benzathine</td><td ID=\"reaction1\">Hives</td><td ID=\"severity1\">Moderate to severe</td><td>Inactive</td></tr><tr><td>Codeine</td><td ID=\"reaction2\">Shortness of Breath</td><td ID=\"severity2\">Moderate</td><td>Active</td></tr><tr><td>Aspirin</td><td ID=\"reaction3\">Hives</td><td ID=\"severity3\">Mild to moderate</td><td>Active</td></tr></tbody></table>",
"Allergies": [
{
"Type": {
"Code": "419511003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Propensity to adverse reaction to drug",
"AltCodes": []
},
"Substance": {
"Code": "7982",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Penicillin G benzathine",
"AltCodes": []
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Rash",
"AltCodes": [],
"Severity": {
"Code": "255604002",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Mild"
},
"Text": null
},
{
"Code": "247472004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Hives",
"AltCodes": [],
"Severity": {
"Code": "6736007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Moderate"
},
"Text": null
}
],
"Severity": {
"Code": "6736007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Moderate"
},
"Criticality": {
"Code": "CRITH",
"CodeSystem": "2.16.840.1.113883.5.1063",
"CodeSystemName": "ObservationValue",
"Name": "High criticality"
},
"Status": {
"Code": "73425007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Inactive"
},
"StartDate": null,
"EndDate": null,
"Comment": "Noted when patient took penicillin for ear infection."
},
{
"Type": {
"Code": "419511003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Propensity to adverse reaction to drug",
"AltCodes": []
},
"Substance": {
"Code": "2670",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Codeine",
"AltCodes": [
{
"Code": "11QV9BS0CB",
"CodeSystem": "2.16.840.1.113883.4.9",
"CodeSystemName": "UNII",
"Name": "Codeine"
}
]
},
"Reaction": [
{
"Code": "267036007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Shortness of Breath",
"AltCodes": [],
"Severity": {
"Code": "6736007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Moderate"
},
"Text": null
}
],
"Severity": {
"Code": "6736007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Moderate"
},
"Criticality": {
"Code": "CRITL",
"CodeSystem": "2.16.840.1.113883.5.1063",
"CodeSystemName": "ObservationValue",
"Name": "Low criticality"
},
"Status": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
},
"StartDate": null,
"EndDate": null,
"Comment": null
},
{
"Type": {
"Code": "419511003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Propensity to adverse reaction to drug",
"AltCodes": []
},
"Substance": {
"Code": "1191",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Aspirin",
"AltCodes": []
},
"Reaction": [
{
"Code": "247472004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Hives",
"AltCodes": [],
"Severity": {
"Code": "371923003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Mild to moderate"
},
"Text": null
}
],
"Severity": {
"Code": "371923003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Mild to moderate"
},
"Criticality": {
"Code": "CRITU",
"CodeSystem": "2.16.840.1.113883.5.1063",
"CodeSystemName": "ObservationValue",
"Name": "Unable to assess criticality"
},
"Status": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
},
"StartDate": null,
"EndDate": null,
"Comment": null
}
],
"EncountersText": "<table width=\"100%\"><thead><tr><th>Encounter</th><th>Performer</th><th>Location</th><th>Date</th></tr></thead><tbody><tr ID=\"Encounter1\"><td>
\nPnuemonia</td><td>Dr Henry Seven</td><td>Community Health and Hospitals</td><td>20120806</td></tr></tbody></table>",
"Encounters": [
{
"Identifiers": [
{
"ID": "2376492",
"IDType": "URMC Epic CSN"
},
{
"ID": "8237334",
"IDType": "1.35.829.5.238422.9.10"
}
],
"Type": {
"Code": "99222",
"CodeSystem": "2.16.840.1.113883.6.12",
"CodeSystemName": "CPT",
"Name": "InPatient Admission",
"AltCodes": []
},
"DateTime": "2012-08-06T04:00:00.000Z",
"EndDateTime": null,
"Providers": [
{
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
},
"Role": {
"Code": "59058001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "General Physician",
"AltCodes": []
}
}
],
"Locations": [
{
"Address": {
"StreetAddress": "1002 Healthcare Dr",
"City": "Portland",
"State": "OR",
"Country": "US",
"ZIP": "97266"
},
"Type": {
"Code": "1160-1",
"CodeSystem": "2.16.840.1.113883.6.259",
"CodeSystemName": "HealthcareServiceLocation",
"Name": "Urgent Care Center",
"AltCodes": []
},
"Name": "Community Health and Hospitals"
}
],
"Diagnosis": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia",
"AltCodes": []
}
],
"ReasonForVisit": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia",
"AltCodes": []
}
]
}
],
"FamilyHistoryText": "<paragraph>Father (deceased)</paragraph><table width=\"100%\"><thead><tr><th>Diagnosis</th><th>Age At Onset</th></tr></thead><tbody><tr><td>Myocardial Infarction (cause of death)</td><td>57</td></tr><tr><td>Diabetes</td><td>40</td></tr></tbody></table>",
"FamilyHistory": [
{
"Relation": {
"Code": "FTH",
"CodeSystem": "2.16.840.1.113883.5.111",
"CodeSystemName": "HL7 FamilyMember",
"Name": "Father",
"Demographics": {
"Sex": "Male",
"DOB": "1912-01-01"
},
"IsDeceased": true
},
"Problems": [
{
"Code": "22298006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Myocardial infarction",
"AltCodes": [],
"Type": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
},
"DateTime": null,
"AgeAtOnset": "57",
"IsCauseOfDeath": null
},
{
"Code": "46635009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Diabetes mellitus type 1",
"AltCodes": [],
"Type": {
"Code": "7087005",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Intermittent"
},
"DateTime": "1994-01-01T05:00:00.000Z",
"AgeAtOnset": "40",
"IsCauseOfDeath": null
}
]
}
],
"ImmunizationText": "<table width=\"100%\"><thead><tr><th>Vaccine</th><th>Date</th><th>Status</th></tr></thead><tbody><tr><td ID=\"immun2\">Influenza virus vaccine, IM</td><td>May 2012</td><td>Completed</td></tr><tr><td ID=\"immun4\">Tetanus and diphtheria toxoids, IM</td><td>Apr 2012</td><td>Completed</td></tr></tbody></table>",
"Immunizations": [
{
"DateTime": "2012-05-10T04:00:00.000Z",
"Route": {
"Code": "C28161",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "National Cancer Institute (NCI) Thesaurus",
"Name": "Intramuscular injection",
"AltCodes": []
},
"Product": {
"Manufacturer": "Health LS - Immuno Inc.",
"Code": "88",
"CodeSystem": "2.16.840.1.113883.6.59",
"CodeSystemName": "CVX",
"Name": "Influenza virus vaccine",
"AltCodes": [],
"LotNumber": null
},
"Dose": {
"Quantity": "50",
"Units": "mcg"
}
},
{
"DateTime": "2012-04-01T04:00:00.000Z",
"Route": {
"Code": "C28161",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "National Cancer Institute (NCI) Thesaurus",
"Name": "Intramuscular injection",
"AltCodes": []
},
"Product": {
"Manufacturer": "Health LS - Immuno Inc.",
"Code": "103",
"CodeSystem": "2.16.840.1.113883.6.59",
"CodeSystemName": "CVX",
"Name": "Tetanus and diphtheria toxoids - preservative free",
"AltCodes": [],
"LotNumber": null
},
"Dose": {
"Quantity": "50",
"Units": "mcg"
}
}
],
"InsurancesText": null,
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductible Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
],
"MedicalEquipmentText": "<table width=\"100%\"><thead><tr><th>Supply/Device</th><th>Date Supplied</th></tr></thead><tbody><tr><td>Automatic implantable cardioverter/defibrillator</td><td>Nov 1999</td></tr><tr><td>Total hip replacement prosthesis</td><td>1998</td></tr><tr><td>Wheelchair</td><td>1999</td></tr></tbody></table>",
"MedicalEquipment": [
{
"Status": "completed",
"StartDate": "1999-11-01T05:00:00.000Z",
"Quantity": "2",
"Product": {
"Code": "72506001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Automatic implantable cardioverter/defibrillator",
"AltCodes": []
}
},
{
"Status": "completed",
"StartDate": "1998-01-01T05:00:00.000Z",
"Quantity": null,
"Product": {
"Code": "304120007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Total hip replacement prosthesis",
"AltCodes": []
}
},
{
"Status": "completed",
"StartDate": "1999-01-01T05:00:00.000Z",
"Quantity": null,
"Product": {
"Code": "58938008",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Wheelchair",
"AltCodes": []
}
}
],
"MedicationsText": "<table width=\"100%\"><thead><tr><th>Medication</th><th>Directions</th><th>Start Date</th><th>Status</th><th>Indications</th><th>Fill Instructions</th></tr></thead><tbody><tr><td ID=\"Med1\">Albuterol 0.09 MG/ACTUAT inhalant solution</td><td>0.09 MG/ACTUAT inhalant solution, 2 puffs once</td><td>20120806</td><td>Active</td><td>Pneumonia (233604007 SNOMED CT)</td><td ID=\"FillIns\">Generic Substitition Allowed</td></tr></tbody></table>",
"Medications": [
{
"Prescription": false,
"FreeTextSig": null,
"Dose": {
"Quantity": "4",
"Units": "mg"
},
"Rate": {
"Quantity": null,
"Units": null
},
"Route": {
"Code": "C38288",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "Oral",
"AltCodes": []
},
"StartDate": "2013-11-11T05:00:00.000Z",
"EndDate": null,
"Frequency": {
"Period": "8",
"Unit": "h"
},
"IsPRN": null,
"Product": {
"Code": "104894",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Ondansetron 4 Mg Po Tbdp",
"AltCodes": [
{
"Code": "0378-7732-93",
"CodeSystem": "2.16.840.1.113883.6.69",
"CodeSystemName": "NDC",
"Name": "Ondansetron 4 Mg Po Tbdp"
},
{
"Code": "64695",
"CodeSystem": "2.16.840.1.113883.6.253",
"CodeSystemName": "MDDID",
"Name": "Ondansetron 4 Mg Po Tbdp"
},
{
"Code": "50250065007220",
"CodeSystem": "2.16.840.1.113883.6.68",
"CodeSystemName": "Medispan GPI",
"Name": "Ondansetron 4 Mg Po Tbdp"
},
{
"Code": "64695",
"CodeSystem": "2.16.840.1.113883.6.162",
"CodeSystemName": "Medispan",
"Name": "Ondansetron 4 Mg Po Tbdp"
}
]
}
},
{
"Prescription": false,
"FreeTextSig": null,
"Dose": {
"Quantity": "0.09",
"Units": "mg/actuat"
},
"Rate": {
"Quantity": "90",
"Units": "ml/min"
},
"Route": {
"Code": "C38216",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "RESPIRATORY (INHALATION)",
"AltCodes": []
},
"StartDate": "2012-08-06T04:00:00.000Z",
"EndDate": "2012-08-13T04:00:00.000Z",
"Frequency": {
"Period": "12",
"Unit": "h"
},
"IsPRN": true,
"Product": {
"Code": "573621",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Albuterol 0.09 MG/ACTUAT inhalant solution",
"AltCodes": []
}
}
],
"PlanOfCareText": "<table width=\"100%\"><thead><tr><th>Planned Activity</th><th>Planned Date</th></tr></thead><tbody><tr><td>Consultation with Dr George Potomac for Asthma</td><td>20120820</td></tr><tr><td>Chest X-ray</td><td>20120826</td></tr><tr><td>Sputum Culture</td><td>20120820</td></tr></tbody></table>",
"PlanOfCare": {
"Orders": [
{
"Code": "624-7",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": null,
"Name": "Sputum Culture",
"AltCodes": [],
"Status": "Request",
"DateTime": "2012-08-20T05:00:00.000Z"
}
],
"Procedures": [
{
"Code": "168731009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Chest X-Ray",
"AltCodes": [],
"Status": "Request",
"DateTime": "2012-08-26T05:00:00.000Z"
}
],
"Encounters": [
{
"Code": "99241",
"CodeSystem": "2.16.840.1.113883.6.12",
"CodeSystemName": "CPT",
"Name": "Office consultation - 15 minutes",
"AltCodes": [],
"Identifiers": [],
"Status": "Intent",
"DateTime": "2012-08-20T05:00:00.000Z"
}
],
"MedicationAdministration": [
{
"Status": "Intent",
"Dose": {
"Quantity": "81",
"Units": "milliGRAM(s)"
},
"Rate": {
"Quantity": null,
"Units": null
},
"Route": {
"Code": "C38288",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "ORAL",
"AltCodes": []
},
"StartDate": "2012-10-02T05:00:00.000Z",
"EndDate": "2012-10-31T04:59:00.000Z",
"Frequency": {
"Period": null,
"Unit": null
},
"Product": {
"Code": "1191",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "aspirin",
"AltCodes": []
}
}
],
"Supplies": [],
"Services": [
{
"Code": "427519008",
"CodeSystem": "2.16.840.1.113883.11.20.9.34",
"CodeSystemName": "patientEducationType",
"Name": "Caregiver",
"AltCodes": [],
"Status": "Intent",
"DateTime": null
}
]
},
"ProblemsText": "<list><item ID=\"problem1\">Pneumonia : Status - Resolved</item><item ID=\"problem2\">Asthma : Status - Active</item></list>",
"Problems": [
{
"StartDate": "2012-08-06T04:00:00.000Z",
"EndDate": "2012-08-06T04:00:00.000Z",
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia",
"AltCodes": [
{
"Code": "J18.9",
"CodeSystem": "2.16.840.1.113883.6.90",
"CodeSystemName": "ICD-10-CM",
"Name": "Pneumonia"
},
{
"Code": "486",
"CodeSystem": "2.16.840.1.113883.6.103",
"CodeSystemName": "ICD-9-CM",
"Name": "Pneumonia"
}
],
"Category": {
"Code": "409586006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Complaint",
"AltCodes": []
},
"HealthStatus": {
"Code": "162467007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Symptom Free",
"AltCodes": []
},
"Status": {
"Code": "413322009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Resolved"
},
"Comment": null
},
{
"StartDate": "2007-10-17T04:00:00.000Z",
"EndDate": "2012-08-06T04:00:00.000Z",
"Code": "195967001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Asthma",
"AltCodes": [
{
"Code": "J45.909",
"CodeSystem": "2.16.840.1.113883.6.90",
"CodeSystemName": "ICD-10-CM",
"Name": "Asthma"
},
{
"Code": "493.90",
"CodeSystem": "2.16.840.1.113883.6.103",
"CodeSystemName": "ICD-9-CM",
"Name": "Asthma"
}
],
"Category": {
"Code": "409586006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Complaint",
"AltCodes": []
},
"HealthStatus": {
"Code": "162467007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Symptom Free",
"AltCodes": []
},
"Status": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
},
"Comment": null
}
],
"ProceduresText": "<table width=\"100%\"><thead><tr><th>Procedure</th><th>Date</th></tr></thead><tbody><tr><td ID=\"Proc2\">Chest X-Ray</td><td>8/7/2012</td></tr></tbody></table>",
"Procedures": {
"Observations": [
{
"Code": "123456",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Fake observation",
"AltCodes": [],
"DateTime": "20120807",
"Status": "active",
"TargetSite": {
"Code": "302539009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Entire hand (body structure)",
"AltCodes": []
}
}
],
"Procedures": [
{
"Code": "168731009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Chest X-Ray",
"AltCodes": [],
"DateTime": "20120807",
"Status": "completed",
"TargetSite": {
"Code": "181608004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Entire chest wall (body structure)",
"AltCodes": []
}
}
],
"Services": [
{
"Code": "123456",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Fake action",
"AltCodes": [],
"DateTime": "20120807",
"Status": "aborted"
}
]
},
"ResultText": "<table><tbody><tr><td colspan=\"2\">LABORATORY INFORMATION</td></tr><tr><td colspan=\"2\">Chemistries and drug levels</td></tr><tr><td ID=\"result1\">HGB (M 13-18 g/dl; F 12-16 g/dl)</td><td>13.2</td></tr><tr><td ID=\"result2\">WBC (4.3-10.8 10+3/ul)</td><td>6.7</td></tr><tr><td ID=\"result3\">PLT (135-145 meq/l)</td><td>123 (L)</td></tr></tbody></table>",
"Results": [
{
"Code": "43789009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "CBC WO DIFFERENTIAL",
"AltCodes": [],
"Status": "Final",
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Observations": [
{
"Code": "30313-1",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "HGB",
"AltCodes": [],
"Status": "Final",
"Interpretation": "Normal",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Value": "10.2",
"ValueType": "PhysicalQuantity",
"Units": "g/dl",
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
}
},
{
"Code": "33765-9",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "WBC",
"AltCodes": [],
"Status": "Final",
"Interpretation": "Normal",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Value": "12.3",
"ValueType": "PhysicalQuantity",
"Units": "10+3/ul",
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
}
},
{
"Code": "26515-7",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "PLT",
"AltCodes": [],
"Status": "Final",
"Interpretation": "Low",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Value": "123",
"ValueType": "PhysicalQuantity",
"Units": "10+3/ul",
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
}
}
]
},
{
"Code": "624-7",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Sputum Culture",
"AltCodes": [],
"Status": null,
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Observations": [
{
"Code": "86243-3",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Color of Sputum",
"AltCodes": [],
"Status": "Final",
"Interpretation": null,
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": "54662009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Green",
"AltCodes": []
},
"Value": "Green",
"ValueType": "Code",
"Units": null,
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
}
}
]
}
],
"SocialHistoryText": "<table width=\"100%\"><thead><tr><th>Social History Element</th><th>Description</th><th>Effective Dates</th></tr></thead><tbody><tr><td ID=\"soc1\">smoking</td><td>Former Smoker (1 pack per day</td><td>20050501 to 20110227</td></tr><tr><td ID=\"soc2\">smoking</td><td>Current Everyday Smoker 2 packs per day</td><td>20110227 - today</td></tr></tbody></table>",
"SocialHistory": {
"Observations": [
{
"Code": "160573003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Alcohol Consumption",
"AltCodes": [],
"Value": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"ValueText": "None",
"StartDate": "1990-05-01T04:00:00.000Z",
"EndDate": null
}
],
"Pregnancy": [],
"TobaccoUse": [
{
"Code": "8517006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Former smoker",
"AltCodes": [],
"IsSmokingStatus": true,
"StartDate": "2015-06-03T09:35:00.000Z",
"EndDate": null
},
{
"Code": "65568007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Cigarette smoker",
"AltCodes": [],
"IsSmokingStatus": false,
"StartDate": "2005-05-01",
"EndDate": "2008-09-01"
}
]
},
"VitalSignsText": "<table width=\"100%\"><thead><tr><th align=\"right\">Date / Time: </th><th>Nov 1, 2011</th><th>August 6, 2012</th></tr></thead><tbody><tr><th align=\"left\">Height</th><td ID=\"vit1\">69 inches</td><td ID=\"vit2\">69 inches</td></tr><tr><th align=\"left\">Weight</th><td ID=\"vit3\">189 lbs</td><td ID=\"vit4\">194 lbs</td></tr><tr><th align=\"left\">Blood Pressure</th><td ID=\"vit5\">132/86 mmHg</td><td ID=\"vit6\">145/88 mmHg</td></tr></tbody></table>",
"VitalSigns": [
{
"DateTime": "1999-11-14T00:00:00.000Z",
"Observations": [
{
"Code": "8302-2",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Height",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "1999-11-14T00:00:00.000Z",
"Value": "177",
"Units": "cm"
},
{
"Code": "3141-9",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Patient Body Weight - Measured",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "1999-11-14T00:00:00.000Z",
"Value": "86",
"Units": "kg"
},
{
"Code": "8480-6",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Intravascular Systolic",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "1999-11-14T00:00:00.000Z",
"Value": "132",
"Units": "mm[Hg]"
}
]
},
{
"DateTime": "2000-04-07T00:00:00.000Z",
"Observations": [
{
"Code": "8302-2",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Height",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "2000-04-07T00:00:00.000Z",
"Value": "177",
"Units": "cm"
},
{
"Code": "3141-9",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Patient Body Weight - Measured",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "2000-04-07T00:00:00.000Z",
"Value": "88",
"Units": "kg"
},
{
"Code": "8480-6",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Intravascular Systolic",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "2000-04-07T00:00:00.000Z",
"Value": "145",
"Units": "mm[Hg]"
}
]
}
]
}
Use PatientPush to send a Clinical Summary to another application or to an EHR or HIE as a Continuity of Care Document (CCD). The body of your request should contain the sections listed below.
The Header section is required and you must include the fields flagged as required. For the other sections, the required flag indicates that a field is required for entries you include in that section. For example, if you populate the Medications section, then each medication must have a product. However, if a given section has no entries then those fields are not required. To indicate that a section is empty, simply send an empty array for that section (e.g.
Medications: []
).The fields for PatientPush are identical to those for Query, except for the following:
Each section in Query contains a "Text" field (e.g.
AllergiesText
) that summarizes the contents of the section. These fields are not included in PatientPush. Redox will generate this summary based on the structured data you send.PatientPush includes an expanded
Document
object in the Header section, allowing you to specify a document author and a visit related to the document (if applicable). Note thatHeader.Document.ID
is required.
Fields
Meta
Meta.DataModel
String
ReliableRequiredClinical Summary
Meta.EventType
String
ReliableRequiredPatientPush
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
Meta.FacilityCode
String
PossibleCode 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.
Header
Header.DirectAddressFrom
PossibleThe sender's Direct address, if one or both sides are using Direct messaging.
Header.DirectAddressTo
PossibleThe recipient's Direct address, if one or both sides are using Direct messaging.
Header.Document
Object
ReliableAn object containing metadata about the document being pushed to the destination.
Header.Document.Author.ID
String
ReliableID of the Provider responsible for the document.
This ID is often required for Inpatient Visits.
Header.Document.Author.IDType
String
ReliableID type of the ID for the Provider responsible for the document
Header.Document.Author.Type
String
ReliableValueSetThe type of provider for this referral
-
Additional values may be added by Redox in the future.
-
Header.Document.Author.FirstName
String
PossibleFirst name of the Provider responsible for the document
Header.Document.Author.LastName
String
PossibleLast name of the Provider responsible for the document
Header.Document.Author.Credentials[]
Array of Strings
PossibleList of credentials for the Provider responsible for the document.
e.g. MD, PhD
Header.Document.Author.Address
Object
PossibleProvider's address
Header.Document.Author.Address.StreetAddress
String
PossibleStreet address
Header.Document.Author.Address.City
String
PossibleCity
Header.Document.Author.Address.State
String
PossibleState
Header.Document.Author.Address.ZIP
String
PossibleZIP
Header.Document.Author.Address.County
String
PossibleCounty
Header.Document.Author.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Header.Document.Author.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Header.Document.Author.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Header.Document.Author.Location
Object
PossibleProvider's location
Header.Document.Author.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Author.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Header.Document.Author.Location.Department
String
PossibleDepartment
Header.Document.Author.Location.Room
String
PossibleRoom.
Example: 136
Header.Document.ID
String
ReliableRequiredYour application's ID for the document
Header.Document.Locale
String
ReliableRequiredThe language of the document.
Header.Document.Title
String
ReliableRequiredThe title of the document.
Header.Document.DateTime
String
ReliableRequiredThe creation/publishing date/time of the document.
Header.Document.Type
String
ReliableThe type of document.
This field is slated to be deprecated in favor of Header.Document.TypeCode.Name
Header.Document.TypeCode.Code
String
ReliableA code describing the type of document.
LOINC Document Type
Header.Document.TypeCode.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Header.Document.TypeCode.CodeSystemName
String
ReliableCoding system to which the code belongs (LOINC preferred).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Header.Document.TypeCode.Name
String
ReliableName of the type of document.
Summarization of Episode Note, Progress Note, etc.
Header.Patient.Identifiers[]
String
ReliableAn array of identifiers for the patient.
Header.Patient.Identifiers[].ID
String
ReliableRequiredThe actual identifier for the patient.
Header.Patient.Identifiers[].IDType
String
ReliableRequiredAn ID type associated with identifier (Medical Record Number, etc.)
Header.Patient.Identifiers[].Type
String
ReliableIf present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.
Header.Patient.Demographics.FirstName
String
ReliableRequiredPatient's first name
Header.Patient.Demographics.LastName
String
ReliableRequiredPatient's last name
Header.Patient.Demographics.DOB
Date
ReliableRequiredPatient's date of birth.
In YYYY-MM-DD format
Header.Patient.Demographics.SSN
String
ReliablePatient SSN
Header.Patient.Demographics.Sex
String
ReliableValueSetRequiredPatient gender
-
Additional values may be added by Redox in the future.
-
Header.Patient.Demographics.Address.StreetAddress
String
Reliable
Header.Patient.Demographics.Address.City
String
Reliable
Header.Patient.Demographics.Address.State
String
Reliable
Header.Patient.Demographics.Address.County
String
Reliable
Header.Patient.Demographics.Address.Country
String
Reliable
Header.Patient.Demographics.Address.ZIP
String
Reliable
Header.Patient.Demographics.PhoneNumber.Home
String
Reliable
Header.Patient.Demographics.PhoneNumber.Mobile
String
Reliable
Header.Patient.Demographics.EmailAddresses[].Address
String
Reliable
Header.Patient.Demographics.Language
String
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Header.Patient.Demographics.Race
String
ReliableOne of the following: American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, White, Other Race'
Header.Patient.Demographics.Ethnicity
String
ReliableOne of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown
Header.Patient.Demographics.Religion
String
Reliable
Header.Patient.Demographics.MaritalStatus
String
ReliableValueSet
-
Additional values may be added by Redox in the future.
-
Header.PCP.ID
String
PossibleID of the Primary Care Provider for the Patient.
This ID is often required for Inpatient Visits.
Header.PCP.IDType
String
PossibleID type of the ID for the Primary Care Provider for the Patient
Header.PCP.Type
String
PossibleValueSetThe type of provider for this referral
-
Additional values may be added by Redox in the future.
-
Header.PCP.FirstName
String
PossibleFirst name of the Primary Care Provider for the Patient
Header.PCP.LastName
String
PossibleLast name of the Primary Care Provider for the Patient
Header.PCP.Credentials[]
Array of Strings
PossibleList of credentials for the Primary Care Provider for the Patient.
e.g. MD, PhD
Header.PCP.Address
Object
PossibleProvider's address
Header.PCP.Address.StreetAddress
String
PossibleStreet address
Header.PCP.Address.City
String
PossibleCity
Header.PCP.Address.State
String
PossibleState
Header.PCP.Address.ZIP
String
PossibleZIP
Header.PCP.Address.County
String
PossibleCounty
Header.PCP.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Header.PCP.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Header.PCP.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Header.PCP.Location
Object
PossibleProvider's location
Header.PCP.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.PCP.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Header.PCP.Location.Department
String
PossibleDepartment
Header.PCP.Location.Room
String
PossibleRoom.
Example: 136
Header.Document.Visit
PossibleNote - visit fields are unlikely in PatientPush. The VisitPush event type should be used instead.
Header.Document.Visit.Location
Object
ReliableIf the document is tied to a visit, this is the location of the visit.
Header.Document.Visit.Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Visit.Location.Facility
String
ReliableFacility.
Example: Community Hospital
Header.Document.Visit.Location.Department
String
ReliableDepartment
Header.Document.Visit.Location.Room
String
ReliableRoom.
Example: 136
Header.Document.Visit.StartDateTime
DateTime
ProbableIf the document is tied to a visit, this is the start date/time of the visit.
ISO 8601 Format
Header.Document.Visit.EndDateTime
String
ProbableIf the document is tied to a visit, this is the end date/time of the visit.
ISO 8601 Format
Header.Document.Visit.Reason
String
ProbableIf the document is tied to a visit, this is the the reason for visit.
Header.Document.Visit.VisitNumber
String
ReliableRequiredID for the patient visit/encounter.
AdvanceDirectives
AdvanceDirectivesText
String
ProbableFree text form of the advance directives summary
AdvanceDirectives[]
Array of Objects
Probable
AdvanceDirectives[].Type.Code
String
ReliableRequiredA code describing the type of advance directive (such as resuscitation).
SNOMED CT
AdvanceDirectives[].Type.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.Name
String
ReliableName of the type of advance directive (such as resuscitation)
AdvanceDirectives[].Type.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of advance directive (such as resuscitation)
AdvanceDirectives[].Type.AltCodes[].Code
String
PossibleA code describing the type of advance directive (such as resuscitation)
AdvanceDirectives[].Type.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.AltCodes[].Name
String
PossibleName of the type of advance directive (such as resuscitation)
AdvanceDirectives[].Code
String
ReliableRequiredA code describing the value of the advance directive (such as 'do not resuscitate').
SNOMED CT
AdvanceDirectives[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Name
String
ReliableName of the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].AltCodes[].Code
String
PossibleA code describing the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].AltCodes[].Name
String
PossibleName of the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].StartDate
DateTime
ReliableRequiredEffective start date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].EndDate
DateTime
ProbableEffective end date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].ExternalReference
String
ProbableA link to a location where the document can be accessed.
AdvanceDirectives[].VerifiedBy[]
Array of Objects
ProbableA collection of people who verified the advance directive with the patient
AdvanceDirectives[].VerifiedBy[].FirstName
String
Probable
AdvanceDirectives[].VerifiedBy[].LastName
String
Probable
AdvanceDirectives[].VerifiedBy[].Credentials
String
Probable
AdvanceDirectives[].VerifiedBy[].DateTime
String
Probable
AdvanceDirectives[].Custodians[]
Array of Objects
ProbablePeople legally resposible for the advance directive document.
AdvanceDirectives[].Custodians[].FirstName
String
Probable
AdvanceDirectives[].Custodians[].LastName
String
Probable
AdvanceDirectives[].Custodians[].Credentials
String
Probable
AdvanceDirectives[].Custodians[].Address.StreetAddress
String
Probable
AdvanceDirectives[].Custodians[].Address.City
String
Probable
AdvanceDirectives[].Custodians[].Address.State
String
Probable
AdvanceDirectives[].Custodians[].Address.Country
String
Probable
AdvanceDirectives[].Custodians[].Address.ZIP
String
Probable
Allergies
AllergyText
String
ReliableFree text form of the allergies summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Allergies[]
Array of Objects
Probable
Allergies[].Type.Code
String
ReliableRequiredA code describing the type of allergy intolerance this is (food, drug, etc.).
SNOMED CT from Allergy/Adverse Event Type Value Set
Allergies[].Type.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.Name
String
ReliableName of the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Type.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Type.AltCodes[].Code
String
PossibleA code describing the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Type.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.AltCodes[].Name
String
PossibleName of the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Substance.Code
String
ReliableRequired
Allergies[].Substance.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.Name
String
ReliableName of the substance that the causes the alergy/intolerance
Allergies[].Substance.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the substance that the causes the alergy/intolerance
Allergies[].Substance.AltCodes[].Code
String
PossibleA code describing the substance that the causes the alergy/intolerance
Allergies[].Substance.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.AltCodes[].Name
String
PossibleName of the substance that the causes the alergy/intolerance
Allergies[].Reaction[]
String
ProbableAll the reactions caused by this particular substance.
SNOMED CT
Allergies[].Reaction[].Code
String
ReliableRequiredA code describing the reaction caused by the allergy (dizziness, hives ,etc.).
SNOMED CT
Allergies[].Reaction[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].Name
String
ReliableName of the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].AltCodes[].Code
String
PossibleA code describing the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].AltCodes[].Name
String
PossibleName of the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].Severity.Code
String
ReliableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT
Allergies[].Reaction[].Severity.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].Severity.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].Severity.Name
String
ReliableName of a code for the severity of the reaction (moderate, severe, etc.)
Allergies[].Reaction[].Text
String
ReliableFree text form of reactions to this substance, includes information that cannot be captured by coded value.
Allergies[].Severity.Code
String
PossibleA 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.
Allergies[].Severity.CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Severity.CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Severity.Name
String
PossibleName of a code for the severity of the reaction (moderate, severe, etc.).
Allergies[].Criticality.Code
String
PossibleA 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.
Allergies[].Criticality.CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Criticality.CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Criticality.Name
String
PossibleName of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
Allergies[].Status.Code
String
ReliableRequiredA code describing the current status of the allergy (active, historic, etc.).
SNOMED CT (Active, Inactive, Resolved)
Allergies[].Status.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Status.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Status.Name
String
ReliableName of the current status of the allergy (active, historic, etc.)
Allergies[].StartDate
String
ProbableWhen the allergy was first noted.
ISO 8601 Format
Allergies[].EndDate
String
ProbableWhen the allergy was no longer a problem (if applicable).
ISO 8601 Format
Allergies[].Comment
String
PossibleFree text comment about the allergy.
Encounters
EncountersText
String
ProbableFree text form of the encounters summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Encounters[]
Array of Objects
Probable
Encounters[].Identifiers[]
Array of Objects
ProbableList of IDs specific to this encounter
Encounters[].Identifiers[].ID
String
ProbableAn ID specific to this encounter
Encounters[].Identifiers[].IDType
String
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Encounters[].Type.Code
String
ReliableRequiredA code describing the type of encounter (office visit, hospital, etc).
CPT-4
Encounters[].Type.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.Name
String
ReliableName of the type of encounter (office visit, hospital, etc)
Encounters[].Type.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of encounter (office visit, hospital, etc)
Encounters[].Type.AltCodes[].Code
String
PossibleA code describing the type of encounter (office visit, hospital, etc)
Encounters[].Type.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.AltCodes[].Name
String
PossibleName of the type of encounter (office visit, hospital, etc)
Encounters[].DateTime
DateTime
ReliableRequiredWhen the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present.
ISO 8601 Format
Encounters[].EndDateTime
DateTime
PossibleWhen the encounter was completed, if available.
ISO 8601 Format
Encounters[].Providers[].ID
String
ProbableID of the Encounter Providers.
This ID is often required for Inpatient Visits.
Encounters[].Providers[].IDType
String
ProbableID type of the ID for the Encounter Providers
Encounters[].Providers[].FirstName
String
PossibleFirst name of the Encounter Providers
Encounters[].Providers[].LastName
String
PossibleLast name of the Encounter Providers
Encounters[].Providers[].Credentials[]
Array of Strings
PossibleList of credentials for the Encounter Providers.
e.g. MD, PhD
Encounters[].Providers[].Address
Object
PossibleProvider's address
Encounters[].Providers[].Address.StreetAddress
String
PossibleStreet address
Encounters[].Providers[].Address.City
String
PossibleCity
Encounters[].Providers[].Address.State
String
PossibleState
Encounters[].Providers[].Address.ZIP
String
PossibleZIP
Encounters[].Providers[].Address.County
String
PossibleCounty
Encounters[].Providers[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Encounters[].Providers[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Encounters[].Providers[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Encounters[].Providers[].Location
Object
PossibleProvider's location
Encounters[].Providers[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Encounters[].Providers[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Encounters[].Providers[].Location.Department
String
PossibleDepartment
Encounters[].Providers[].Location.Room
String
PossibleRoom.
Example: 136
Encounters[].Providers[].Role.Code
String
ProbableA code describing the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.Name
String
ProbableName of the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.AltCodes[].Code
String
PossibleA code describing the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.AltCodes[].Name
String
PossibleName of the role of the provider (pcp, general physician, etc.)
Encounters[].Locations[]
String
Probable
Encounters[].Locations[].Address.StreetAddress
String
Probable
Encounters[].Locations[].Address.City
String
Probable
Encounters[].Locations[].Address.State
String
Probable
Encounters[].Locations[].Address.Country
String
Probable
Encounters[].Locations[].Address.ZIP
String
Probable
Encounters[].Locations[].Type.Code
String
ProbableA code describing the type of location where the patient was seen (clinic, urgent care, hostpital).
Heathcare Service Location
Encounters[].Locations[].Type.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.Name
String
ProbableName of the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].Type.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].Type.AltCodes[].Code
String
PossibleA code describing the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].Type.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.AltCodes[].Name
String
PossibleName of the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].Name
String
ProbableThe name of the location
Encounters[].Diagnosis[]
String
ProbableList of Diagnoses associated with the visit.
SNOMED CT
Encounters[].Diagnosis[].Code
String
ProbableA code describing the associated diagnosis
Encounters[].Diagnosis[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].Name
String
ProbableName of the associated diagnosis
Encounters[].Diagnosis[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the associated diagnosis
Encounters[].Diagnosis[].AltCodes[].Code
String
PossibleA code describing the associated diagnosis
Encounters[].Diagnosis[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].AltCodes[].Name
String
PossibleName of the associated diagnosis
Encounters[].ReasonForVisit[].Code
String
ProbableA code describing the reason for the visit (usually this is what the patient reports).
SNOMED CT
Encounters[].ReasonForVisit[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].Name
String
ProbableName of the reason for the visit (usually this is what the patient reports)
Encounters[].ReasonForVisit[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the reason for the visit (usually this is what the patient reports)
Encounters[].ReasonForVisit[].AltCodes[].Code
String
PossibleA code describing the reason for the visit (usually this is what the patient reports)
Encounters[].ReasonForVisit[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].AltCodes[].Name
String
PossibleName of the reason for the visit (usually this is what the patient reports)
FamilyHistory
FamilyHistoryText
String
ProbableFree text form of the family history summary
FamilyHistory[]
Array of Objects
ProbableEach element of the FamilyHistory is one person in the patient's family.
FamilyHistory[].Relation.Code
String
ReliableRequiredA code describing the family member's relationship (father, mother, maternal grandfather, etc.).
HL7 Family History Related Subjects
FamilyHistory[].Relation.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Relation.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Relation.Name
String
ReliableName of the family member's relationship (father, mother, maternal grandfather, etc.)
FamilyHistory[].Relation.Demographics.Sex
String
ProbableValueSetGender of the relative
-
Additional values may be added by Redox in the future.
-
FamilyHistory[].Relation.Demographics.DOB
String
ProbableDate of Birth of the relative.
In YYYY-MM-DD format
FamilyHistory[].Relation.IsDeceased
Boolean
ProbableWhether or not the relative is deceased
FamilyHistory[].Problems[]
String
ReliableA list of the relative's relevant health problems
FamilyHistory[].Problems[].Code
String
ReliableRequiredA code describing a particular problem experienced by the relative.
SNOMED CT
FamilyHistory[].Problems[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].Name
String
ReliableName of a particular problem experienced by the relative
FamilyHistory[].Problems[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for a particular problem experienced by the relative
FamilyHistory[].Problems[].AltCodes[].Code
String
PossibleA code describing a particular problem experienced by the relative
FamilyHistory[].Problems[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].AltCodes[].Name
String
PossibleName of a particular problem experienced by the relative
FamilyHistory[].Problems[].Type.Code
String
ReliableRequiredA code describing the general class of the problem. (disease, problem, etc.).
Problem Type Value Set
FamilyHistory[].Problems[].Type.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].Type.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].Type.Name
String
ReliableName of the general class of the problem. (disease, problem, etc.)
FamilyHistory[].Problems[].DateTime
String
ProbableThe time when the problem started.
ISO 8601 Format
FamilyHistory[].Problems[].AgeAtOnset
String
ProbableThe relative's age when the problem started
FamilyHistory[].Problems[].IsCauseOfDeath
Boolean
ProbableFlag indicating whether or not this problem was the cause of death for the relative.
Immunizations
ImmunizationText
String
ProbableFree text form of the immunization summary
Immunizations[]
Array of Objects
ReliableArray of immunizations for patient.
Immunizations[].DateTime
String
ReliableRequiredWhen the immunization was given.
ISO 8601 Format
Immunizations[].Route.Code
String
ProbableA code describing the way in which the immunization was delivered (intramuscular, oral, etc.).
Medication Route FDA Value Set
Immunizations[].Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.Name
String
ProbableName of the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Route.AltCodes[].Code
String
PossibleA code describing the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.AltCodes[].Name
String
PossibleName of the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Product.Manufacturer
String
ProbableName of organization that manufacture the immunization.
Free text
Immunizations[].Product.Code
String
ReliableRequiredA code describing the vaccination that was given.
CVX code system
Immunizations[].Product.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.Name
String
ReliableName of the vaccination that was given
Immunizations[].Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the vaccination that was given
Immunizations[].Product.AltCodes[].Code
String
PossibleA code describing the vaccination that was given
Immunizations[].Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.AltCodes[].Name
String
PossibleName of the vaccination that was given
Immunizations[].Product.LotNumber
String
ProbableThe lot number of the vaccine
Immunizations[].Dose.Quantity
String
ProbableThe size of the dose
Immunizations[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Insurances
InsurancesText
String
PossibleFree text form of the patient's insurances.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Insurances[]
Array of Objects
PossibleList of insurance coverages for the patient
Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Insurances[].Plan.Name
String
ProbableName of insurance plan
Insurances[].Plan.Type
String
PossibleType of insurance plan
Insurances[].MemberNumber
String
PossiblePatient member number
Insurances[].Company.ID
String
PossibleID of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.IDType
String
PossibleID type of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Insurances[].Company.Address
Object
ProbableInsurance company's address
Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Insurances[].Company.Address.City
String
ProbableCity
Insurances[].Company.Address.State
String
ProbableState
Insurances[].Company.Address.ZIP
String
ProbableZIP
Insurances[].Company.Address.County
String
PossibleCounty
Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Insurances[].GroupNumber
String
ProbableInsurance policy group number
Insurances[].GroupName
String
PossibleInsurance policy group name.
Typically not available in ClinicalSummary.
Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Insurances[].PolicyNumber
String
ProbableInsurance policy number
Insurances[].AgreementType
String
PossibleType of insurance agreement.
Typically not available in ClinicalSummary.
Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Insurances[].Insured.LastName
String
PossibleLast name of the insured
Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Insurances[].Insured.SSN
String
PossibleInsured's social security number
Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.Address
Object
ProbableAddress of the insured
Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Insurances[].Insured.Address.City
String
ProbableCity
Insurances[].Insured.Address.State
String
ProbableState
Insurances[].Insured.Address.ZIP
String
ProbableZIP
Insurances[].Insured.Address.County
String
PossibleCounty
Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
MedicalEquipment
MedicalEquipmentText
String
ProbableFree text form of the medical equipment summary
MedicalEquipment[]
String
ProbableA list of medical equipment that the patient uses (cane, pacemakers, etc.)
MedicalEquipment[].Status
String
ReliableRequiredThe current status of the equipment (active, completed, etc.)
MedicalEquipment[].StartDate
String
ProbableWhen the equipment was first put into use.
ISO 8601 Format
MedicalEquipment[].Quantity
String
ProbableThe number of products used
MedicalEquipment[].Product.Code
String
ProbableA code describing the actual product.
SNOMED CT
MedicalEquipment[].Product.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.Name
String
ProbableName of the actual product.
MedicalEquipment[].Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual product.
MedicalEquipment[].Product.AltCodes[].Code
String
PossibleA code describing the actual product.
MedicalEquipment[].Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.AltCodes[].Name
String
PossibleName of the actual product.
Medications
MedicationsText
String
ReliableFree text form of the medications summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Medications[]
Array of Objects
Probable
Medications[].Prescription
Boolean
ReliableRequiredWhether the medication is a prescription.
For a prescription: true. For a patient reported med, or a med administered by a provider: false
Medications[].FreeTextSig
String
PossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
Medications[].Dose.Quantity
String
ProbableThe size of the dose for pills, capsules, etc.
Medications[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Medications[].Rate.Quantity
String
ProbableIf the medication is in liquid form, the rate at which it is administered
Medications[].Rate.Units
String
ProbableUnits for the rate.
UCUM Units of Measure
Medications[].Route.Code
String
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
Medications[].Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.Name
String
ProbableName of the method by which the medication is delivered
Medications[].Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the method by which the medication is delivered
Medications[].Route.AltCodes[].Code
String
PossibleA code describing the method by which the medication is delivered
Medications[].Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.AltCodes[].Name
String
PossibleName of the method by which the medication is delivered
Medications[].StartDate
String
ReliableRequiredWhen the medication was started.
ISO 8601 Format
Medications[].EndDate
String
ProbableWhen the medication ended.
ISO 8601 Format
Medications[].Frequency.Period
String
ProbableHow often the patient should be taking the medication.
UCUM Units of Measure
Medications[].Frequency.Unit
String
ProbableUnits for how often the patient should be taking the medication
Medications[].IsPRN
Boolean
ProbableWhether the medication is to be taken on an as-needed basis
Medications[].Product.Code
String
ReliableRequiredA code describing the actual medication given .
RxNorm
Medications[].Product.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.Name
String
ReliableName of the actual medication given
Medications[].Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual medication given
Medications[].Product.AltCodes[].Code
String
PossibleA code describing the actual medication given
Medications[].Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.AltCodes[].Name
String
PossibleName of the actual medication given
PlanOfCare
PlanOfCareText
String
ProbableFree text form of the plan of care summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
PlanOfCare.Orders[]
Array of Objects
ProbableFuture lab tests or other diagnostic procedures.
PlanOfCare.Orders[].Code
String
ProbableA code describing the test to be performed .
LOINC
PlanOfCare.Orders[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].Name
String
ProbableName of the test to be performed
PlanOfCare.Orders[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the test to be performed
PlanOfCare.Orders[].AltCodes[].Code
String
PossibleA code describing the test to be performed
PlanOfCare.Orders[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].AltCodes[].Name
String
PossibleName of the test to be performed
PlanOfCare.Orders[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Orders[].DateTime
ISO Format
Probable
PlanOfCare.Procedures[]
Array of Objects
ProbableFuture procedures.
PlanOfCare.Procedures[].Code
String
ProbableA code describing the planned procedure, such as an appendectomy or hip replacement .
SNOMED CT
PlanOfCare.Procedures[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].Name
String
ProbableName of the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].AltCodes[].Code
String
PossibleA code describing the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].AltCodes[].Name
String
PossibleName of the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Procedures[].DateTime
ISO Format
Probable
PlanOfCare.Encounters[]
Array of Objects
ProbableAppointments and other upcoming encounters
PlanOfCare.Encounters[].Code
String
ProbableA code describing the planned encounter type .
SNOMED CT
PlanOfCare.Encounters[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].Name
String
ProbableName of the planned encounter type
PlanOfCare.Encounters[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned encounter type
PlanOfCare.Encounters[].AltCodes[].Code
String
PossibleA code describing the planned encounter type
PlanOfCare.Encounters[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].AltCodes[].Name
String
PossibleName of the planned encounter type
PlanOfCare.Encounters[].Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identifies the encounter
PlanOfCare.Encounters[].Identifiers[].ID
String
PossibleID for the encounter
PlanOfCare.Encounters[].Identifiers[].IDType
String
PossibleType of ID
PlanOfCare.Encounters[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Encounters[].DateTime
String
Probable
PlanOfCare.MedicationAdministration[]
Array of Objects
ProbablePlanned medication
PlanOfCare.MedicationAdministration[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.MedicationAdministration[].Dose.Quantity
String
ProbableThe size of the dose for pills, capsules, etc.
PlanOfCare.MedicationAdministration[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Rate.Quantity
String
ProbableIf the medication is not in does form, this is the rate at which is administered
PlanOfCare.MedicationAdministration[].Rate.Units
String
ProbableUnits for the rate.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Route.Code
String
ProbableA code describing the method by which the medication is to be delivered.
Medication Route FDA Value Set
PlanOfCare.MedicationAdministration[].Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.Name
String
ProbableName of the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].Route.AltCodes[].Code
String
PossibleA code describing the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.AltCodes[].Name
String
PossibleName of the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].StartDate
ISO Format
ProbableWhen the medication was started
PlanOfCare.MedicationAdministration[].EndDate
ISO Format
ProbableWhen the medication ended
PlanOfCare.MedicationAdministration[].Frequency.Period
String
ProbableHow often the patient should be taking the medication.
UCUM Units of measure
PlanOfCare.MedicationAdministration[].Frequency.Unit
String
ProbableUnits for how often the patient should be taking the medication
PlanOfCare.MedicationAdministration[].Product.Code
String
ProbableA code describing the planned medication .
RxNorm
PlanOfCare.MedicationAdministration[].Product.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.Name
String
ProbableName of the planned medication
PlanOfCare.MedicationAdministration[].Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned medication
PlanOfCare.MedicationAdministration[].Product.AltCodes[].Code
String
PossibleA code describing the planned medication
PlanOfCare.MedicationAdministration[].Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.AltCodes[].Name
String
PossibleName of the planned medication
PlanOfCare.Supplies[]
Array of Objects
ProbableFuture supplies that a patient may be given, including implants.
PlanOfCare.Supplies[].Code
String
ProbableA code describing the planned product.
SNOMED CT
PlanOfCare.Supplies[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].Name
String
ProbableName of the planned product
PlanOfCare.Supplies[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned product
PlanOfCare.Supplies[].AltCodes[].Code
String
PossibleA code describing the planned product
PlanOfCare.Supplies[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].AltCodes[].Name
String
PossibleName of the planned product
PlanOfCare.Supplies[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Supplies[].DateTime
ISO Format
ProbableThe scheduled time of the activity. .
ISO 8601 Format
PlanOfCare.Services[]
Array of Objects
ProbablePlanned activities that are service-oriented in nature, such as a dressing change, or feeding a patient.
PlanOfCare.Services[].Code
String
ProbableA code describing the planned activity.
SNOMED CT
PlanOfCare.Services[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].Name
String
ProbableName of the planned activity.
PlanOfCare.Services[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the planned activity.
PlanOfCare.Services[].AltCodes[].Code
String
PossibleA code describing the planned activity.
PlanOfCare.Services[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].AltCodes[].Name
String
PossibleName of the planned activity.
PlanOfCare.Services[].Status
String
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Services[].DateTime
ISO Format
ProbableThe scheduled time of the activity. .
ISO 8601 Format
Problems
ProblemsText
String
ReliableFree text form of the problems summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Problems[]
Array of Objects
ReliableAn array of all of patient relevant problems, current and historical.
Problems[].StartDate
String
ProbableWhen the problem was noticed.
ISO 8601 Format
Problems[].EndDate
String
ProbableWhen the problem stopped (if it is not current).
ISO 8601 Format
Problems[].Code
String
ReliableRequiredA code describing the actual problem .
SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009)
Problems[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Name
String
ReliableName of the actual problem
Problems[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual problem
Problems[].AltCodes[].Code
String
PossibleA code describing the actual problem
Problems[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].AltCodes[].Name
String
PossibleName of the actual problem
Problems[].Category.Code
String
ReliableRequiredA code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.Name
String
ReliableName of the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.AltCodes[].Code
String
PossibleA code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.AltCodes[].Name
String
PossibleName of the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].HealthStatus.Code
String
ProbableA code describing the effect of the problem on the patient (chronically ill, in remission, etc.).
SNOMED-CT
Problems[].HealthStatus.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.Name
String
ProbableName of the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].HealthStatus.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].HealthStatus.AltCodes[].Code
String
PossibleA code describing the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].HealthStatus.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.AltCodes[].Name
String
PossibleName of the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].Status.Code
String
ProbableA code describing the current state of the problem (active, inactive, resolved).
HITSPProblemStatus
Problems[].Status.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Status.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Status.Name
String
ProbableName of the current state of the problem (active, inactive, resolved)
Problems[].Comment
String
PossibleFree text comment about the problem
Procedures
ProceduresText
String
ProbableFree text form of the procedures summary
Procedures
ProbableA 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.
Procedures.Observations[]
ProbableThese are procedures that are more observational in nature, such as an EEG or EKG.
Procedures.Observations[].Code
String
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Observations[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].Name
String
ProbableName of the procedure that was performed.
Procedures.Observations[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the procedure that was performed.
Procedures.Observations[].AltCodes[].Code
String
PossibleA code describing the procedure that was performed.
Procedures.Observations[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].AltCodes[].Name
String
PossibleName of the procedure that was performed.
Procedures.Observations[].DateTime
ProbableWhen the procedure was performed.
Procedures.Observations[].Status
ProbableThe status of the procedure.
Procedures.Observations[].TargetSite.Code
String
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Observations[].TargetSite.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.Name
String
ProbableName of the location on the body where the procedure was performed
Procedures.Observations[].TargetSite.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the location on the body where the procedure was performed
Procedures.Observations[].TargetSite.AltCodes[].Code
String
PossibleA code describing the location on the body where the procedure was performed
Procedures.Observations[].TargetSite.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.AltCodes[].Name
String
PossibleName of the location on the body where the procedure was performed
Procedures.Procedures[]
ProbableThese are procedures that alter the state of the body, such as an appendectomy or hip replacement.
Procedures.Procedures[].Code
String
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Procedures[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].Name
String
ProbableName of the procedure that was performed.
Procedures.Procedures[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the procedure that was performed.
Procedures.Procedures[].AltCodes[].Code
String
PossibleA code describing the procedure that was performed.
Procedures.Procedures[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].AltCodes[].Name
String
PossibleName of the procedure that was performed.
Procedures.Procedures[].DateTime
ProbableWhen the procedure was performed.
Procedures.Procedures[].Status
ProbableThe status of the procedure.
Procedures.Procedures[].TargetSite.Code
String
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Procedures[].TargetSite.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.Name
String
ProbableName of the location on the body where the procedure was performed
Procedures.Procedures[].TargetSite.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the location on the body where the procedure was performed
Procedures.Procedures[].TargetSite.AltCodes[].Code
String
PossibleA code describing the location on the body where the procedure was performed
Procedures.Procedures[].TargetSite.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.AltCodes[].Name
String
PossibleName of the location on the body where the procedure was performed
Procedures.Services[]
ProbableThese are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient.
Procedures.Services[].Code
String
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Services[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].Name
String
ProbableName of the procedure that was performed.
Procedures.Services[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the procedure that was performed.
Procedures.Services[].AltCodes[].Code
String
PossibleA code describing the procedure that was performed.
Procedures.Services[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].AltCodes[].Name
String
PossibleName of the procedure that was performed.
Procedures.Services[].DateTime
ProbableWhen the procedure was performed.
Procedures.Services[].Status
ProbableThe status of the procedure.
Results
ResultText
String
ReliableFree text form of the results summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Results[]
ProbableArray of test results for the patient. This can include laboratory results, imaging results, and procedure results.
Results[].Code
String
ReliableRequiredA code describing the test performed and resulted.
LOINC for Lab, SNOMED CT otherwise
Results[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Name
String
ReliableName of the test performed and resulted.
Results[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the test performed and resulted.
Results[].AltCodes[].Code
String
PossibleA code describing the test performed and resulted.
Results[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].AltCodes[].Name
String
PossibleName of the test performed and resulted.
Results[].Status
String
ReliableRequiredThe status of the test (In Progress, Final)
Results[].Producer.ID
String
PossibleID of the producer for this result.
The "Producer" is typically the Lab which did the resulting.
Results[].Producer.Name
String
PossibleName of the producer
Results[].Producer.IDType
String
PossibleID Type for the corresponding ID of this producer
Results[].Producer.Address
Object
PossibleResult producer's address
Results[].Producer.Address.StreetAddress
String
PossibleStreet address
Results[].Producer.Address.City
String
PossibleCity
Results[].Producer.Address.State
String
PossibleState
Results[].Producer.Address.ZIP
String
PossibleZIP
Results[].Producer.Address.County
String
PossibleCounty
Results[].Producer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Results[].Observations[]
Array of Object
ReliableA list of corresponding observations for the test (result components)
Results[].Observations[].Code
String
ReliableRequiredA code describing the individual result component. .
LOINC for Lab, SNOMED CT otherwise
Results[].Observations[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].Name
String
ReliableName of the individual result component.
Results[].Observations[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the individual result component.
Results[].Observations[].AltCodes[].Code
String
PossibleA code describing the individual result component.
Results[].Observations[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].AltCodes[].Name
String
PossibleName of the individual result component.
Results[].Observations[].Status
String
ReliableRequiredThe status of the individual component. Some tests may have different components finish at different times. .
One of (In Progress, Final)
Results[].Observations[].Interpretation
String
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
Results[].Observations[].DateTime
String
ReliableRequiredA specific date/time when the value was recorded.
ISO 8601 Format
Results[].Observations[].CodedValue.Code
String
PossibleA 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
Results[].Observations[].CodedValue.CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.Name
String
PossibleName of the individual result value.
Results[].Observations[].CodedValue.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the individual result value.
Results[].Observations[].CodedValue.AltCodes[].Code
String
PossibleA code describing the individual result value.
Results[].Observations[].CodedValue.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.AltCodes[].Name
String
PossibleName of the individual result value.
Results[].Observations[].Value
String
ReliableRequiredThe measurement recorded for the result.
Results[].Observations[].ValueType
String
ReliableThe type and format of the value.
One of the following: PhysicalQuantity, String, Number, Interval, Ratio, Code. Intervals will be represented in Value as low-high, <low, <=low, >high, or >=high. Ratios will be represented in Value as numerator:denominator.
Results[].Observations[].Units
String
ReliableRequiredThe units of the measurement.
Only available when ValueType is PhysicalQuantity
Results[].Observations[].ReferenceRange
Object
PossibleReference 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.
Results[].Observations[].ReferenceRange.Low
Numeric
PossibleLower bound for a normal result
Results[].Observations[].ReferenceRange.High
Numeric
PossibleUpper bound for a normal result
Results[].Observations[].ReferenceRange.Text
String
PossibleThe normal value for non-numeric results
SocialHistory
SocialHistoryText
String
ProbableFree text form of the social history summary
SocialHistory.Observations[]
String
ProbableGeneric observations about the patient's social hisotry that don't fall into the smoking or pregnancy categories.
SocialHistory.Observations[].Code
String
ProbableA code describing a type of social history observation (exercise, alcohol intake, etc.) .
SNOMED CT
SocialHistory.Observations[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Name
String
ProbableName of a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].AltCodes[].Code
String
PossibleA code describing a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].AltCodes[].Name
String
PossibleName of a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].Value
Object
ProbableThe observed value
SocialHistory.Observations[].Value.Code
String
ProbableA code describing the observed value, if coded
SocialHistory.Observations[].Value.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.Name
String
ProbableName of the observed value, if coded
SocialHistory.Observations[].Value.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the observed value, if coded
SocialHistory.Observations[].Value.AltCodes[].Code
String
PossibleA code describing the observed value, if coded
SocialHistory.Observations[].Value.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.AltCodes[].Name
String
PossibleName of the observed value, if coded
SocialHistory.Observations[].ValueText
String
ProbableThe observed value, if uncoded
SocialHistory.Observations[].StartDate
String
ProbableStart date of status
SocialHistory.Observations[].EndDate
String
ProbableDate status ended. If this is null, the status is current.
SocialHistory.Pregnancy[]
String
ProbableInformation about past and current pregnancies.
SocialHistory.Pregnancy[].StartDate
String
ProbableWhen the pregnancy started.
ISO 8601 Format
SocialHistory.Pregnancy[].EndDate
String
ProbableWhen the pregnancy ended.
ISO 8601 Format
SocialHistory.Pregnancy[].EstimatedDelivery
String
ProbableEstimate delivery date if pregnancy is still active.
SocialHistory.TobaccoUse[]
String
ProbableContains tobacco use and smoking status observations
SocialHistory.TobaccoUse[].Code
String
ProbableA 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
SocialHistory.TobaccoUse[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].Name
String
ProbableName of the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].AltCodes[].Code
String
PossibleA code describing the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].AltCodes[].Name
String
PossibleName of the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].IsSmokingStatus
Boolean
ProbableIdentifies this tobacco use entry as a smoking status.
If true, StartDate is the date the smoking status was observed.
SocialHistory.TobaccoUse[].StartDate
String
ProbableStart date of status.
If IsSmokingStatus is true, this is the date the observation was made.
SocialHistory.TobaccoUse[].EndDate
String
ProbableDate status ended. If this is null, the status is current.
VitalSigns
VitalSignsText
String
ProbableFree text form of the vital signs summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
VitalSigns[]
String
ProbableAn array of groups of vital signs.
VitalSigns[].DateTime
String
PossibleThe 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.
VitalSigns[].Observations[]
String
ReliableAn array of individual vital sign Observations[].
VitalSigns[].Observations[].Code
String
ReliableRequiredA code describing the type of vital sign being read (height, weight, blood pressure, etc.).
LOINC (HITSP Vital Sign Result Type).
VitalSigns[].Observations[].CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].Name
String
ReliableName of the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].AltCodes[].Code
String
PossibleA code describing the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].AltCodes[].Name
String
PossibleName of the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].Status
String
ReliableRequiredThe status of the reading (usually completed)
VitalSigns[].Observations[].Interpretation
String
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
VitalSigns[].Observations[].DateTime
String
ReliableRequiredThe date/time when the specific vital sign was recorded.
ISO 8601 Format
VitalSigns[].Observations[].Value
String
ReliableRequiredThe measurement recorded for the vital sign.
VitalSigns[].Observations[].Units
String
ReliableRequiredThe units of the measurement.
UCUM Units of Measure
{
"Meta": {
"DataModel": "Clinical Summary",
"EventType": "PatientPush",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "ef9e7448-7f65-4432-aa96-059647e9b358",
"Name": "Patient Push Endpoint"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Header": {
"DirectAddressFrom": "[email protected]",
"DirectAddressTo": "[email protected]",
"Document": {
"Author": {
"ID": "4356789876",
"IDType": "NPI",
"Type": null,
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ID": "75cb4ad4-e5f9-4cd3-8750-eb5050521e0d",
"Locale": "US",
"Title": "Community Health and Hospitals: Health Summary",
"DateTime": "2012-09-12T00:00:00.000Z",
"Type": "Summarization of Episode Note",
"TypeCode": {
"Code": "34133-9",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Summarization of Episode Note"
},
"Visit": {
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
},
"StartDateTime": null,
"EndDateTime": null,
"Reason": null,
"VisitNumber": null
}
},
"Patient": {
"Identifiers": [
{
"ID": "1234",
"IDType": "2.16.840.1.113883.4.6",
"Type": null
}
],
"Demographics": {
"FirstName": "Myra",
"LastName": "Jones",
"DOB": "1947-05-01",
"SSN": "123-101-1234",
"Sex": "Female",
"Address": {
"StreetAddress": "1357 Amber Drive",
"City": "Beaverton",
"State": "OR",
"County": null,
"Country": "US",
"ZIP": "97006"
},
"PhoneNumber": {
"Home": "+18162766909",
"Mobile": null
},
"EmailAddresses": [
{
"Address": "[email protected]"
}
],
"Language": null,
"Race": "White",
"Ethnicity": "Not Hispanic or Latino",
"Religion": "Christian (non-Catholic, non-specific)",
"MaritalStatus": "Married"
}
},
"PCP": {
"ID": null,
"IDType": null,
"Type": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
},
"AdvanceDirectivesText": "<table width=\"100%\"><thead><tr><th>Directive</th><th>Description</th><th>Verification</th><th>Supporting Document(s)</th></tr></thead><tbody><tr><td>Resuscitation status</td><td ID=\"AD1\">Do not resuscitate</td><td>Dr. Robert Dolin, Nov 07, 1999</td><td><linkHtml href=\"AdvanceDirective.b50b7910-7ffb-4f4c-bbe4-177ed68cbbf3.pdf\">Advance directive</linkHtml></td></tr></tbody></table>",
"AdvanceDirectives": [
{
"Type": {
"Code": "304251008",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Resuscitation",
"AltCodes": []
},
"Code": "304253006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Do not resuscitate",
"AltCodes": [],
"StartDate": "2011-02-13T05:00:00.000Z",
"EndDate": null,
"ExternalReference": "AdvanceDirective.b50b7910-7ffb-4f4c-bbe4-177ed68cbbf3.pdf",
"VerifiedBy": [
{
"FirstName": "Robert",
"LastName": "Dolin",
"Credentials": "Dr.",
"DateTime": null
}
],
"Custodians": [
{
"FirstName": "Robert",
"LastName": "Dolin",
"Credentials": "Dr.",
"Address": {
"StreetAddress": "21 North Ave.",
"City": "Burlington",
"State": "MA",
"Country": "USA",
"ZIP": "02368"
}
}
]
}
],
"AllergyText": "<table width=\"100%\"><thead><tr><th>Substance</th><th>Reaction</th><th>Severity</th><th>Status</th></tr></thead><tbody><tr><td>Penicillin G benzathine</td><td ID=\"reaction1\">Hives</td><td ID=\"severity1\">Moderate to severe</td><td>Inactive</td></tr><tr><td>Codeine</td><td ID=\"reaction2\">Shortness of Breath</td><td ID=\"severity2\">Moderate</td><td>Active</td></tr><tr><td>Aspirin</td><td ID=\"reaction3\">Hives</td><td ID=\"severity3\">Mild to moderate</td><td>Active</td></tr></tbody></table>",
"Allergies": [
{
"Type": {
"Code": "419511003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Propensity to adverse reaction to drug",
"AltCodes": []
},
"Substance": {
"Code": "7982",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Penicillin G benzathine",
"AltCodes": []
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Rash",
"AltCodes": [],
"Severity": {
"Code": "255604002",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Mild"
},
"Text": null
},
{
"Code": "247472004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Hives",
"AltCodes": [],
"Severity": {
"Code": "6736007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Moderate"
},
"Text": null
}
],
"Severity": {
"Code": "6736007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Moderate"
},
"Criticality": {
"Code": "CRITH",
"CodeSystem": "2.16.840.1.113883.5.1063",
"CodeSystemName": "ObservationValue",
"Name": "High criticality"
},
"Status": {
"Code": "73425007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Inactive"
},
"StartDate": null,
"EndDate": null,
"Comment": "Noted when patient took penicillin for ear infection."
},
{
"Type": {
"Code": "419511003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Propensity to adverse reaction to drug",
"AltCodes": []
},
"Substance": {
"Code": "2670",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Codeine",
"AltCodes": [
{
"Code": "11QV9BS0CB",
"CodeSystem": "2.16.840.1.113883.4.9",
"CodeSystemName": "UNII",
"Name": "Codeine"
}
]
},
"Reaction": [
{
"Code": "267036007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Shortness of Breath",
"AltCodes": [],
"Severity": {
"Code": "6736007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Moderate"
},
"Text": null
}
],
"Severity": {
"Code": "6736007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Moderate"
},
"Criticality": {
"Code": "CRITL",
"CodeSystem": "2.16.840.1.113883.5.1063",
"CodeSystemName": "ObservationValue",
"Name": "Low criticality"
},
"Status": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
},
"StartDate": null,
"EndDate": null,
"Comment": null
},
{
"Type": {
"Code": "419511003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Propensity to adverse reaction to drug",
"AltCodes": []
},
"Substance": {
"Code": "1191",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Aspirin",
"AltCodes": []
},
"Reaction": [
{
"Code": "247472004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Hives",
"AltCodes": [],
"Severity": {
"Code": "371923003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Mild to moderate"
},
"Text": null
}
],
"Severity": {
"Code": "371923003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Mild to moderate"
},
"Criticality": {
"Code": "CRITU",
"CodeSystem": "2.16.840.1.113883.5.1063",
"CodeSystemName": "ObservationValue",
"Name": "Unable to assess criticality"
},
"Status": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
},
"StartDate": null,
"EndDate": null,
"Comment": null
}
],
"EncountersText": "<table width=\"100%\"><thead><tr><th>Encounter</th><th>Performer</th><th>Location</th><th>Date</th></tr></thead><tbody><tr ID=\"Encounter1\"><td>
\nPnuemonia</td><td>Dr Henry Seven</td><td>Community Health and Hospitals</td><td>20120806</td></tr></tbody></table>",
"Encounters": [
{
"Identifiers": [
{
"ID": "2376492",
"IDType": "URMC Epic CSN"
},
{
"ID": "8237334",
"IDType": "1.35.829.5.238422.9.10"
}
],
"Type": {
"Code": "99222",
"CodeSystem": "2.16.840.1.113883.6.12",
"CodeSystemName": "CPT",
"Name": "InPatient Admission",
"AltCodes": []
},
"DateTime": "2012-08-06T04:00:00.000Z",
"EndDateTime": null,
"Providers": [
{
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
},
"Role": {
"Code": "59058001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "General Physician",
"AltCodes": []
}
}
],
"Locations": [
{
"Address": {
"StreetAddress": "1002 Healthcare Dr",
"City": "Portland",
"State": "OR",
"Country": "US",
"ZIP": "97266"
},
"Type": {
"Code": "1160-1",
"CodeSystem": "2.16.840.1.113883.6.259",
"CodeSystemName": "HealthcareServiceLocation",
"Name": "Urgent Care Center",
"AltCodes": []
},
"Name": "Community Health and Hospitals"
}
],
"Diagnosis": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia",
"AltCodes": []
}
],
"ReasonForVisit": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia",
"AltCodes": []
}
]
}
],
"FamilyHistoryText": "<paragraph>Father (deceased)</paragraph><table width=\"100%\"><thead><tr><th>Diagnosis</th><th>Age At Onset</th></tr></thead><tbody><tr><td>Myocardial Infarction (cause of death)</td><td>57</td></tr><tr><td>Diabetes</td><td>40</td></tr></tbody></table>",
"FamilyHistory": [
{
"Relation": {
"Code": "FTH",
"CodeSystem": "2.16.840.1.113883.5.111",
"CodeSystemName": "HL7 FamilyMember",
"Name": "Father",
"Demographics": {
"Sex": "Male",
"DOB": "1912-01-01"
},
"IsDeceased": true
},
"Problems": [
{
"Code": "22298006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Myocardial infarction",
"AltCodes": [],
"Type": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
},
"DateTime": null,
"AgeAtOnset": "57",
"IsCauseOfDeath": null
},
{
"Code": "46635009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Diabetes mellitus type 1",
"AltCodes": [],
"Type": {
"Code": "7087005",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Intermittent"
},
"DateTime": "1994-01-01T05:00:00.000Z",
"AgeAtOnset": "40",
"IsCauseOfDeath": null
}
]
}
],
"ImmunizationText": "<table width=\"100%\"><thead><tr><th>Vaccine</th><th>Date</th><th>Status</th></tr></thead><tbody><tr><td ID=\"immun2\">Influenza virus vaccine, IM</td><td>May 2012</td><td>Completed</td></tr><tr><td ID=\"immun4\">Tetanus and diphtheria toxoids, IM</td><td>Apr 2012</td><td>Completed</td></tr></tbody></table>",
"Immunizations": [
{
"DateTime": "2012-05-10T04:00:00.000Z",
"Route": {
"Code": "C28161",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "National Cancer Institute (NCI) Thesaurus",
"Name": "Intramuscular injection",
"AltCodes": []
},
"Product": {
"Manufacturer": "Health LS - Immuno Inc.",
"Code": "88",
"CodeSystem": "2.16.840.1.113883.6.59",
"CodeSystemName": "CVX",
"Name": "Influenza virus vaccine",
"AltCodes": [],
"LotNumber": null
},
"Dose": {
"Quantity": "50",
"Units": "mcg"
}
},
{
"DateTime": "2012-04-01T04:00:00.000Z",
"Route": {
"Code": "C28161",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "National Cancer Institute (NCI) Thesaurus",
"Name": "Intramuscular injection",
"AltCodes": []
},
"Product": {
"Manufacturer": "Health LS - Immuno Inc.",
"Code": "103",
"CodeSystem": "2.16.840.1.113883.6.59",
"CodeSystemName": "CVX",
"Name": "Tetanus and diphtheria toxoids - preservative free",
"AltCodes": [],
"LotNumber": null
},
"Dose": {
"Quantity": "50",
"Units": "mcg"
}
}
],
"InsurancesText": null,
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductible Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
],
"MedicalEquipmentText": "<table width=\"100%\"><thead><tr><th>Supply/Device</th><th>Date Supplied</th></tr></thead><tbody><tr><td>Automatic implantable cardioverter/defibrillator</td><td>Nov 1999</td></tr><tr><td>Total hip replacement prosthesis</td><td>1998</td></tr><tr><td>Wheelchair</td><td>1999</td></tr></tbody></table>",
"MedicalEquipment": [
{
"Status": "completed",
"StartDate": "1999-11-01T05:00:00.000Z",
"Quantity": "2",
"Product": {
"Code": "72506001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Automatic implantable cardioverter/defibrillator",
"AltCodes": []
}
},
{
"Status": "completed",
"StartDate": "1998-01-01T05:00:00.000Z",
"Quantity": null,
"Product": {
"Code": "304120007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Total hip replacement prosthesis",
"AltCodes": []
}
},
{
"Status": "completed",
"StartDate": "1999-01-01T05:00:00.000Z",
"Quantity": null,
"Product": {
"Code": "58938008",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Wheelchair",
"AltCodes": []
}
}
],
"MedicationsText": "<table width=\"100%\"><thead><tr><th>Medication</th><th>Directions</th><th>Start Date</th><th>Status</th><th>Indications</th><th>Fill Instructions</th></tr></thead><tbody><tr><td ID=\"Med1\">Albuterol 0.09 MG/ACTUAT inhalant solution</td><td>0.09 MG/ACTUAT inhalant solution, 2 puffs once</td><td>20120806</td><td>Active</td><td>Pneumonia (233604007 SNOMED CT)</td><td ID=\"FillIns\">Generic Substitition Allowed</td></tr></tbody></table>",
"Medications": [
{
"Prescription": false,
"FreeTextSig": null,
"Dose": {
"Quantity": "4",
"Units": "mg"
},
"Rate": {
"Quantity": null,
"Units": null
},
"Route": {
"Code": "C38288",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "Oral",
"AltCodes": []
},
"StartDate": "2013-11-11T05:00:00.000Z",
"EndDate": null,
"Frequency": {
"Period": "8",
"Unit": "h"
},
"IsPRN": null,
"Product": {
"Code": "104894",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Ondansetron 4 Mg Po Tbdp",
"AltCodes": [
{
"Code": "0378-7732-93",
"CodeSystem": "2.16.840.1.113883.6.69",
"CodeSystemName": "NDC",
"Name": "Ondansetron 4 Mg Po Tbdp"
},
{
"Code": "64695",
"CodeSystem": "2.16.840.1.113883.6.253",
"CodeSystemName": "MDDID",
"Name": "Ondansetron 4 Mg Po Tbdp"
},
{
"Code": "50250065007220",
"CodeSystem": "2.16.840.1.113883.6.68",
"CodeSystemName": "Medispan GPI",
"Name": "Ondansetron 4 Mg Po Tbdp"
},
{
"Code": "64695",
"CodeSystem": "2.16.840.1.113883.6.162",
"CodeSystemName": "Medispan",
"Name": "Ondansetron 4 Mg Po Tbdp"
}
]
}
},
{
"Prescription": false,
"FreeTextSig": null,
"Dose": {
"Quantity": "0.09",
"Units": "mg/actuat"
},
"Rate": {
"Quantity": "90",
"Units": "ml/min"
},
"Route": {
"Code": "C38216",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "RESPIRATORY (INHALATION)",
"AltCodes": []
},
"StartDate": "2012-08-06T04:00:00.000Z",
"EndDate": "2012-08-13T04:00:00.000Z",
"Frequency": {
"Period": "12",
"Unit": "h"
},
"IsPRN": true,
"Product": {
"Code": "573621",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Albuterol 0.09 MG/ACTUAT inhalant solution",
"AltCodes": []
}
}
],
"PlanOfCareText": "<table width=\"100%\"><thead><tr><th>Planned Activity</th><th>Planned Date</th></tr></thead><tbody><tr><td>Consultation with Dr George Potomac for Asthma</td><td>20120820</td></tr><tr><td>Chest X-ray</td><td>20120826</td></tr><tr><td>Sputum Culture</td><td>20120820</td></tr></tbody></table>",
"PlanOfCare": {
"Orders": [
{
"Code": "624-7",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": null,
"Name": "Sputum Culture",
"AltCodes": [],
"Status": "Request",
"DateTime": "2012-08-20T05:00:00.000Z"
}
],
"Procedures": [
{
"Code": "168731009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Chest X-Ray",
"AltCodes": [],
"Status": "Request",
"DateTime": "2012-08-26T05:00:00.000Z"
}
],
"Encounters": [
{
"Code": "99241",
"CodeSystem": "2.16.840.1.113883.6.12",
"CodeSystemName": "CPT",
"Name": "Office consultation - 15 minutes",
"AltCodes": [],
"Identifiers": [],
"Status": "Intent",
"DateTime": "2012-08-20T05:00:00.000Z"
}
],
"MedicationAdministration": [
{
"Status": "Intent",
"Dose": {
"Quantity": "81",
"Units": "milliGRAM(s)"
},
"Rate": {
"Quantity": null,
"Units": null
},
"Route": {
"Code": "C38288",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "ORAL",
"AltCodes": []
},
"StartDate": "2012-10-02T05:00:00.000Z",
"EndDate": "2012-10-31T04:59:00.000Z",
"Frequency": {
"Period": null,
"Unit": null
},
"Product": {
"Code": "1191",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "aspirin",
"AltCodes": []
}
}
],
"Supplies": [],
"Services": [
{
"Code": "427519008",
"CodeSystem": "2.16.840.1.113883.11.20.9.34",
"CodeSystemName": "patientEducationType",
"Name": "Caregiver",
"AltCodes": [],
"Status": "Intent",
"DateTime": null
}
]
},
"ProblemsText": "<list><item ID=\"problem1\">Pneumonia : Status - Resolved</item><item ID=\"problem2\">Asthma : Status - Active</item></list>",
"Problems": [
{
"StartDate": "2012-08-06T04:00:00.000Z",
"EndDate": "2012-08-06T04:00:00.000Z",
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia",
"AltCodes": [
{
"Code": "J18.9",
"CodeSystem": "2.16.840.1.113883.6.90",
"CodeSystemName": "ICD-10-CM",
"Name": "Pneumonia"
},
{
"Code": "486",
"CodeSystem": "2.16.840.1.113883.6.103",
"CodeSystemName": "ICD-9-CM",
"Name": "Pneumonia"
}
],
"Category": {
"Code": "409586006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Complaint",
"AltCodes": []
},
"HealthStatus": {
"Code": "162467007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Symptom Free",
"AltCodes": []
},
"Status": {
"Code": "413322009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Resolved"
},
"Comment": null
},
{
"StartDate": "2007-10-17T04:00:00.000Z",
"EndDate": "2012-08-06T04:00:00.000Z",
"Code": "195967001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Asthma",
"AltCodes": [
{
"Code": "J45.909",
"CodeSystem": "2.16.840.1.113883.6.90",
"CodeSystemName": "ICD-10-CM",
"Name": "Asthma"
},
{
"Code": "493.90",
"CodeSystem": "2.16.840.1.113883.6.103",
"CodeSystemName": "ICD-9-CM",
"Name": "Asthma"
}
],
"Category": {
"Code": "409586006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Complaint",
"AltCodes": []
},
"HealthStatus": {
"Code": "162467007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Symptom Free",
"AltCodes": []
},
"Status": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
},
"Comment": null
}
],
"ProceduresText": "<table width=\"100%\"><thead><tr><th>Procedure</th><th>Date</th></tr></thead><tbody><tr><td ID=\"Proc2\">Chest X-Ray</td><td>8/7/2012</td></tr></tbody></table>",
"Procedures": {
"Observations": [
{
"Code": "123456",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Fake observation",
"AltCodes": [],
"DateTime": "20120807",
"Status": "active",
"TargetSite": {
"Code": "302539009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Entire hand (body structure)",
"AltCodes": []
}
}
],
"Procedures": [
{
"Code": "168731009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Chest X-Ray",
"AltCodes": [],
"DateTime": "20120807",
"Status": "completed",
"TargetSite": {
"Code": "181608004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Entire chest wall (body structure)",
"AltCodes": []
}
}
],
"Services": [
{
"Code": "123456",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Fake action",
"AltCodes": [],
"DateTime": "20120807",
"Status": "aborted"
}
]
},
"ResultText": "<table><tbody><tr><td colspan=\"2\">LABORATORY INFORMATION</td></tr><tr><td colspan=\"2\">Chemistries and drug levels</td></tr><tr><td ID=\"result1\">HGB (M 13-18 g/dl; F 12-16 g/dl)</td><td>13.2</td></tr><tr><td ID=\"result2\">WBC (4.3-10.8 10+3/ul)</td><td>6.7</td></tr><tr><td ID=\"result3\">PLT (135-145 meq/l)</td><td>123 (L)</td></tr></tbody></table>",
"Results": [
{
"Code": "43789009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "CBC WO DIFFERENTIAL",
"AltCodes": [],
"Status": "Final",
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Observations": [
{
"Code": "30313-1",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "HGB",
"AltCodes": [],
"Status": "Final",
"Interpretation": "Normal",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Value": "10.2",
"ValueType": "PhysicalQuantity",
"Units": "g/dl",
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
}
},
{
"Code": "33765-9",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "WBC",
"AltCodes": [],
"Status": "Final",
"Interpretation": "Normal",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Value": "12.3",
"ValueType": "PhysicalQuantity",
"Units": "10+3/ul",
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
}
},
{
"Code": "26515-7",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "PLT",
"AltCodes": [],
"Status": "Final",
"Interpretation": "Low",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Value": "123",
"ValueType": "PhysicalQuantity",
"Units": "10+3/ul",
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
}
}
]
},
{
"Code": "624-7",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Sputum Culture",
"AltCodes": [],
"Status": null,
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Observations": [
{
"Code": "86243-3",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Color of Sputum",
"AltCodes": [],
"Status": "Final",
"Interpretation": null,
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": "54662009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Green",
"AltCodes": []
},
"Value": "Green",
"ValueType": "Code",
"Units": null,
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
}
}
]
}
],
"SocialHistoryText": "<table width=\"100%\"><thead><tr><th>Social History Element</th><th>Description</th><th>Effective Dates</th></tr></thead><tbody><tr><td ID=\"soc1\">smoking</td><td>Former Smoker (1 pack per day</td><td>20050501 to 20110227</td></tr><tr><td ID=\"soc2\">smoking</td><td>Current Everyday Smoker 2 packs per day</td><td>20110227 - today</td></tr></tbody></table>",
"SocialHistory": {
"Observations": [
{
"Code": "160573003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Alcohol Consumption",
"AltCodes": [],
"Value": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"ValueText": "None",
"StartDate": "1990-05-01T04:00:00.000Z",
"EndDate": null
}
],
"Pregnancy": [],
"TobaccoUse": [
{
"Code": "8517006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Former smoker",
"AltCodes": [],
"IsSmokingStatus": true,
"StartDate": "2015-06-03T09:35:00.000Z",
"EndDate": null
},
{
"Code": "65568007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Cigarette smoker",
"AltCodes": [],
"IsSmokingStatus": false,
"StartDate": "2005-05-01",
"EndDate": "2008-09-01"
}
]
},
"VitalSignsText": "<table width=\"100%\"><thead><tr><th align=\"right\">Date / Time: </th><th>Nov 1, 2011</th><th>August 6, 2012</th></tr></thead><tbody><tr><th align=\"left\">Height</th><td ID=\"vit1\">69 inches</td><td ID=\"vit2\">69 inches</td></tr><tr><th align=\"left\">Weight</th><td ID=\"vit3\">189 lbs</td><td ID=\"vit4\">194 lbs</td></tr><tr><th align=\"left\">Blood Pressure</th><td ID=\"vit5\">132/86 mmHg</td><td ID=\"vit6\">145/88 mmHg</td></tr></tbody></table>",
"VitalSigns": [
{
"DateTime": "1999-11-14T00:00:00.000Z",
"Observations": [
{
"Code": "8302-2",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Height",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "1999-11-14T00:00:00.000Z",
"Value": "177",
"Units": "cm"
},
{
"Code": "3141-9",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Patient Body Weight - Measured",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "1999-11-14T00:00:00.000Z",
"Value": "86",
"Units": "kg"
},
{
"Code": "8480-6",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Intravascular Systolic",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "1999-11-14T00:00:00.000Z",
"Value": "132",
"Units": "mm[Hg]"
}
]
},
{
"DateTime": "2000-04-07T00:00:00.000Z",
"Observations": [
{
"Code": "8302-2",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Height",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "2000-04-07T00:00:00.000Z",
"Value": "177",
"Units": "cm"
},
{
"Code": "3141-9",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Patient Body Weight - Measured",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "2000-04-07T00:00:00.000Z",
"Value": "88",
"Units": "kg"
},
{
"Code": "8480-6",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Intravascular Systolic",
"AltCodes": [],
"Status": "completed",
"Interpretation": "Normal",
"DateTime": "2000-04-07T00:00:00.000Z",
"Value": "145",
"Units": "mm[Hg]"
}
]
}
]
}
This query finds and returns visit summaries for a given patient at the specified health system within the specified timeframe. Include the fields listed in the VisitQuery section in the body of your request. The response will contain these sections: Header, Allergies, Assessment, ChiefComplaint, Encounters, HistoryOfPresentIllness, Instructions, Interventions, Medications, Objective, PhysicalExam, PlanOfCare, Problems, ReasonForReferral, ReasonForVisit, Results, ReviewOfSystems, Subjective, VitalSigns.
You must provide the patient's medical record number (MRN) as part of the query. The ID type that corresponds to the MRN varies per health system. You should work with the health system to determine which ID type to send. If you do not already have a patient's MRN on file, you can obtain it using the PatientSearch data model. For testing purposes, the Redox Health System is connected to the NIST Document Sharing Test Facility, which uses the "NIST" ID type for the MRN. The PatientSearch data model will return a NIST ID that you should use with the VisitQuery.
Fields
Meta
Meta.DataModel
String
ReliableRequiredClinical Summary
Meta.EventType
String
ReliableRequiredVisitQuery
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
Meta.FacilityCode
String
PossibleCode 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.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and IDTypes for the patient
Patient.Identifiers[].ID
String
ReliableRequiredID of the Patient
Patient.Identifiers[].IDType
String
ReliableRequiredID Type for the corresponding ID of this patient (ie. MRN, EHRID)
Visit
Visit.VisitNumber
String
ReliableID for the patient visit/encounter. Either this or a timeframe is required to accurately locate a visit.
Visit.StartDateTime
ISO Format
ReliableBeginning of the timeframe for which to request visit summaries. Either this or a visit number is required to accurately locate a visit.
ISO 8601 Format
Visit.EndDateTime
ISO Format
ProbableEnd of the timeframe for which to request visit summaries.
ISO 8601 Format
{
"Meta": {
"DataModel": "Clinical Summary",
"EventType": "VisitQuery",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"Test": true,
"Destinations": [
{
"ID": "ef9e7448-7f65-4432-aa96-059647e9b357",
"Name": "Visit Query Endpoint"
}
],
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
]
},
"Visit": {
"VisitNumber": "4325235",
"StartDateTime": "2005-02-21T00:00:00.000Z",
"EndDateTime": null
}
}
This is the format of the response you will receive for a VisitQuery messages.
Fields
Meta
Meta.DataModel
String
ReliableRequiredClinical Summary
Meta.EventType
String
ReliableRequiredVisitQueryResponse
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
Meta.FacilityCode
String
PossibleCode 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.
Header
Header.Document
Object
ReliableAn object containing metadata about the document being pushed to the destination.
Header.Document.Author.ID
String
ReliableID of the Provider responsible for the document.
This ID is often required for Inpatient Visits.
Header.Document.Author.IDType
String
ReliableID type of the ID for the Provider responsible for the document
Header.Document.Author.Type
String
ReliableValueSetThe type of provider for this referral
-
Additional values may be added by Redox in the future.
-
Header.Document.Author.FirstName
String
PossibleFirst name of the Provider responsible for the document
Header.Document.Author.LastName
String
PossibleLast name of the Provider responsible for the document
Header.Document.Author.Credentials[]
Array of Strings
PossibleList of credentials for the Provider responsible for the document.
e.g. MD, PhD
Header.Document.Author.Address
Object
PossibleProvider's address
Header.Document.Author.Address.StreetAddress
String
PossibleStreet address
Header.Document.Author.Address.City
String
PossibleCity
Header.Document.Author.Address.State
String
PossibleState
Header.Document.Author.Address.ZIP
String
PossibleZIP
Header.Document.Author.Address.County
String
PossibleCounty
Header.Document.Author.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Header.Document.Author.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Header.Document.Author.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Header.Document.Author.Location
Object
PossibleProvider's location
Header.Document.Author.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Author.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Header.Document.Author.Location.Department
String
PossibleDepartment
Header.Document.Author.Location.Room
String
PossibleRoom.
Example: 136
Header.Document.ID
String
ReliableRequiredYour application's ID for the document
Header.Document.Locale
String
ReliableRequiredThe language of the document.
Header.Document.Title
String
ReliableRequiredThe title of the document.
Header.Document.DateTime
String
ReliableRequiredThe creation/publishing date/time of the document.
Header.Document.Type
String
ReliableThe type of document.
This field is slated to be deprecated in favor of Header.Document.TypeCode.Name
Header.Document.TypeCode.Code
String
ReliableA code describing the type of document.
LOINC Document Type
Header.Document.TypeCode.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Header.Document.TypeCode.CodeSystemName
String
ReliableCoding system to which the code belongs (LOINC preferred).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Header.Document.TypeCode.Name
String
ReliableName of the type of document.
Summarization of Episode Note, Progress Note, etc.
Header.Patient.Identifiers[]
String
ReliableAn array of identifiers for the patient.
Header.Patient.Identifiers[].ID
String
ReliableRequiredThe actual identifier for the patient.
Header.Patient.Identifiers[].IDType
String
ReliableRequiredAn ID type associated with identifier (Medical Record Number, etc.)
Header.Patient.Identifiers[].Type
String
ReliableIf present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.
Header.Patient.Demographics.FirstName
String
ReliableRequiredPatient's first name
Header.Patient.Demographics.LastName
String
ReliableRequiredPatient's last name
Header.Patient.Demographics.DOB
Date
ReliableRequiredPatient's date of birth.
In YYYY-MM-DD format
Header.Patient.Demographics.SSN
String
ReliablePatient SSN
Header.Patient.Demographics.Sex
String
ReliableValueSetRequiredPatient gender
-
Additional values may be added by Redox in the future.
-
Header.Patient.Demographics.Address.StreetAddress
String
Reliable
Header.Patient.Demographics.Address.City
String
Reliable
Header.Patient.Demographics.Address.State
String
Reliable
Header.Patient.Demographics.Address.County
String
Reliable
Header.Patient.Demographics.Address.Country
String
Reliable
Header.Patient.Demographics.Address.ZIP
String
Reliable
Header.Patient.Demographics.PhoneNumber.Home
String
Reliable
Header.Patient.Demographics.PhoneNumber.Mobile
String
Reliable
Header.Patient.Demographics.EmailAddresses[].Address
String
Reliable
Header.Patient.Demographics.Language
String
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Header.Patient.Demographics.Race
String
ReliableOne of the following: American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, White, Other Race'
Header.Patient.Demographics.Ethnicity
String
ReliableOne of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown
Header.Patient.Demographics.Religion
String
Reliable
Header.Patient.Demographics.MaritalStatus
String
ReliableValueSet
-
Additional values may be added by Redox in the future.
-
Header.PCP.ID
String
PossibleID of the Primary Care Provider for the Patient.
This ID is often required for Inpatient Visits.
Header.PCP.IDType
String
PossibleID type of the ID for the Primary Care Provider for the Patient
Header.PCP.Type
String
PossibleValueSetThe type of provider for this referral
-
Additional values may be added by Redox in the future.
-
Header.PCP.FirstName
String
PossibleFirst name of the Primary Care Provider for the Patient
Header.PCP.LastName
String
PossibleLast name of the Primary Care Provider for the Patient
Header.PCP.Credentials[]
Array of Strings
PossibleList of credentials for the Primary Care Provider for the Patient.
e.g. MD, PhD
Header.PCP.Address
Object
PossibleProvider's address
Header.PCP.Address.StreetAddress
String
PossibleStreet address
Header.PCP.Address.City
String
PossibleCity
Header.PCP.Address.State
String
PossibleState
Header.PCP.Address.ZIP
String
PossibleZIP
Header.PCP.Address.County
String
PossibleCounty
Header.PCP.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Header.PCP.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Header.PCP.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Header.PCP.Location
Object
PossibleProvider's location
Header.PCP.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.PCP.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Header.PCP.Location.Department
String
PossibleDepartment
Header.PCP.Location.Room
String
PossibleRoom.
Example: 136
Header.Document.Visit.Location
Object
ReliableIf the document is tied to a visit, this is the location of the visit.
Header.Document.Visit.Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Visit.Location.Facility
String
ReliableFacility.
Example: Community Hospital
Header.Document.Visit.Location.Department
String
ReliableDepartment
Header.Document.Visit.Location.Room
String
ReliableRoom.
Example: 136
Header.Document.Visit.StartDateTime
DateTime
ProbableIf the document is tied to a visit, this is the start date/time of the visit.
ISO 8601 Format
Header.Document.Visit.EndDateTime
String
ProbableIf the document is tied to a visit, this is the end date/time of the visit.
IS