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.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
E.g. New, Update
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
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[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
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[].IDString
ReliableRequiredID of the Patient
Patient.Identifiers[].IDTypeString
ReliableRequiredID Type for the corresponding ID of this patient (ie. MRN, EHRID)
Location
Location.DepartmentString
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": "2019-10-24T23:54:41.339Z",
"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.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
E.g. New, Update
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
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[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
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.DocumentObject
ReliableAn object containing metadata about the document being pushed to the destination.
Header.Document.Author.IDString
ReliableID of the Provider responsible for the document.
This ID is often required for Inpatient Visits.
Header.Document.Author.IDTypeString
ReliableID type of the ID for the Provider responsible for the document
Header.Document.Author.TypeString
ReliableThe type of provider for this referral.
One of the following: "Referring Provider", "Referred To Provider", "Other", "Patient PCP"
Header.Document.Author.FirstNameString
PossibleFirst name of the Provider responsible for the document
Header.Document.Author.LastNameString
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.AddressObject
PossibleProvider's address
Header.Document.Author.Address.StreetAddressString
PossibleStreet address
Header.Document.Author.Address.CityString
PossibleCity
Header.Document.Author.Address.StateString
PossibleState
Header.Document.Author.Address.ZIPString
PossibleZIP
Header.Document.Author.Address.CountyString
PossibleCounty
Header.Document.Author.Address.CountryString
PossibleCountry
Header.Document.Author.EmailAddresses[]Array of Strings
ProbableProvider's email address(es)
Header.Document.Author.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Header.Document.Author.LocationObject
PossibleProvider's location
Header.Document.Author.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Author.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Header.Document.Author.Location.DepartmentString
PossibleDepartment
Header.Document.Author.Location.RoomString
PossibleRoom.
Example: 136
Header.Document.IDString
ReliableRequiredYour application's ID for the document
Header.Document.LocaleString
ReliableRequiredThe language of the document.
Header.Document.TitleString
ReliableRequiredThe title of the document.
Header.Document.DateTimeString
ReliableRequiredThe creation/publishing date/time of the document.
Header.Document.TypeString
ReliableRequiredThe type of document (Patient Summary, Visit Summary, etc.)
Header.Patient.Identifiers[]String
ReliableAn array of identifiers for the patient.
Header.Patient.Identifiers[].IDString
ReliableRequiredThe actual identifier for the patient.
Header.Patient.Identifiers[].IDTypeString
ReliableRequiredAn ID type associated with identifier (Medical Record Number, etc.)
Header.Patient.Identifiers[].TypeString
ReliableIf present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.
Header.Patient.Demographics.FirstNameString
ReliableRequiredPatient's first name
Header.Patient.Demographics.LastNameString
ReliableRequiredPatient's last name
Header.Patient.Demographics.DOBDate
ReliableRequiredPatient's date of birth.
In YYYY-MM-DD format
Header.Patient.Demographics.SSNString
ReliablePatient SSN
Header.Patient.Demographics.SexString
ReliableRequiredPatient gender
-
Additional values may be added by Redox in the future.
-
Header.Patient.Demographics.Address.StreetAddressString
Reliable
Header.Patient.Demographics.Address.CityString
Reliable
Header.Patient.Demographics.Address.StateString
Reliable
Header.Patient.Demographics.Address.CountyString
Reliable
Header.Patient.Demographics.Address.CountryString
Reliable
Header.Patient.Demographics.Address.ZIPString
Reliable
Header.Patient.Demographics.PhoneNumber.HomeString
Reliable
Header.Patient.Demographics.PhoneNumber.MobileString
Reliable
Header.Patient.Demographics.EmailAddresses[].AddressString
Reliable
Header.Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Header.Patient.Demographics.RaceString
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.EthnicityString
ReliableOne of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown
Header.Patient.Demographics.ReligionString
Reliable
Header.Patient.Demographics.MaritalStatusString
Reliable
-
Additional values may be added by Redox in the future.
-
AdvanceDirectives
AdvanceDirectivesTextString
ProbableFree text form of the advance directives summary
AdvanceDirectives[]Array of Objects
Probable
AdvanceDirectives[].Type.CodeString
ReliableRequiredA code describing the type of advance directive (such as resuscitation).
SNOMED CT
AdvanceDirectives[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.NameString
ReliableName of the type of advance directive (such as resuscitation)
AdvanceDirectives[].CodeString
ReliableRequiredA code describing the value of the advance directive (such as 'do not resuscitate').
SNOMED CT
AdvanceDirectives[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].NameString
ReliableName of the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].StartDateDateTime
ReliableRequiredEffective start date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].EndDateDateTime
ProbableEffective end date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].ExternalReferenceString
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[].FirstNameString
Probable
AdvanceDirectives[].VerifiedBy[].LastNameString
Probable
AdvanceDirectives[].VerifiedBy[].CredentialsString
Probable
AdvanceDirectives[].VerifiedBy[].DateTimeString
Probable
AdvanceDirectives[].Custodians[]Array of Objects
ProbablePeople legally resposible for the advance directive document.
AdvanceDirectives[].Custodians[].FirstNameString
Probable
AdvanceDirectives[].Custodians[].LastNameString
Probable
AdvanceDirectives[].Custodians[].CredentialsString
Probable
AdvanceDirectives[].Custodians[].Address.StreetAddressString
Probable
AdvanceDirectives[].Custodians[].Address.CityString
Probable
AdvanceDirectives[].Custodians[].Address.StateString
Probable
AdvanceDirectives[].Custodians[].Address.CountryString
Probable
AdvanceDirectives[].Custodians[].Address.ZIPString
Probable
Allergies
AllergyTextString
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.CodeString
ReliableRequiredA code describing the type of allergy intolerance this is (food, drug, etc.).
SNOMED CT from Allergy/Adverse Event Type Value Set
Allergies[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.NameString
ReliableName of the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Substance.CodeString
ReliableRequired
Allergies[].Substance.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.NameString
ReliableName of the substance that the causes the alergy/intolerance
Allergies[].Reaction[]String
ProbableAll the reactions caused by this particular substance.
SNOMED CT
Allergies[].Reaction[].CodeString
ReliableRequiredA code describing the reaction caused by the allergy (dizziness, hives ,etc.).
SNOMED CT
Allergies[].Reaction[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].NameString
ReliableName of the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].Severity.CodeString
ReliableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT
Allergies[].Reaction[].Severity.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].Severity.NameString
ReliableName of a code for the severity of the reaction (moderate, severe, etc.)
Allergies[].Reaction[].TextString
ReliableFree text form of reactions to this substance, includes information that cannot be captured by coded value.
Allergies[].Severity.CodeString
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.CodeSystemString
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.CodeSystemNameString
PossibleCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Severity.NameString
PossibleName of a code for the severity of the reaction (moderate, severe, etc.).
Allergies[].Criticality.CodeString
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.CodeSystemString
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.CodeSystemNameString
PossibleCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Criticality.NameString
PossibleName of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
Allergies[].Status.CodeString
ReliableRequiredA code describing the current status of the allergy (active, historic, etc.).
SNOMED CT (Active, Inactive, Resolved)
Allergies[].Status.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Status.NameString
ReliableName of the current status of the allergy (active, historic, etc.)
Allergies[].StartDateString
ProbableWhen the allergy was first noted.
ISO 8601 Format
Allergies[].EndDateString
ProbableWhen the allergy was no longer a problem (if applicable).
ISO 8601 Format
Allergies[].CommentString
PossibleFree text comment about the allergy.
Encounters
EncountersTextString
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[].IDString
ProbableAn ID specific to this encounter
Encounters[].Identifiers[].IDTypeString
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Encounters[].Type.CodeString
ReliableRequiredA code describing the type of encounter (office visit, hospital, etc).
CPT-4
Encounters[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.NameString
ReliableName of the type of encounter (office visit, hospital, etc)
Encounters[].DateTimeDateTime
ReliableRequiredWhen the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present.
ISO 8601 Format
Encounters[].EndDateTimeDateTime
PossibleWhen the encounter was completed, if available.
ISO 8601 Format
Encounters[].Providers[].IDString
ProbableID of the Encounter Providers.
This ID is often required for Inpatient Visits.
Encounters[].Providers[].IDTypeString
ProbableID type of the ID for the Encounter Providers
Encounters[].Providers[].FirstNameString
PossibleFirst name of the Encounter Providers
Encounters[].Providers[].LastNameString
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[].AddressObject
PossibleProvider's address
Encounters[].Providers[].Address.StreetAddressString
PossibleStreet address
Encounters[].Providers[].Address.CityString
PossibleCity
Encounters[].Providers[].Address.StateString
PossibleState
Encounters[].Providers[].Address.ZIPString
PossibleZIP
Encounters[].Providers[].Address.CountyString
PossibleCounty
Encounters[].Providers[].Address.CountryString
PossibleCountry
Encounters[].Providers[].EmailAddresses[]Array of Strings
ProbableProvider's email address(es)
Encounters[].Providers[].PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Encounters[].Providers[].LocationObject
PossibleProvider's location
Encounters[].Providers[].Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Encounters[].Providers[].Location.FacilityString
PossibleFacility.
Example: Community Hospital
Encounters[].Providers[].Location.DepartmentString
PossibleDepartment
Encounters[].Providers[].Location.RoomString
PossibleRoom.
Example: 136
Encounters[].Providers[].Role.CodeString
ProbableA code describing the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.NameString
ProbableName of the role of the provider (pcp, general physician, etc.)
Encounters[].Locations[]String
Probable
Encounters[].Locations[].Address.StreetAddressString
Probable
Encounters[].Locations[].Address.CityString
Probable
Encounters[].Locations[].Address.StateString
Probable
Encounters[].Locations[].Address.CountryString
Probable
Encounters[].Locations[].Address.ZIPString
Probable
Encounters[].Locations[].Type.CodeString
ProbableA code describing the type of location where the patient was seen (clinic, urgent care, hostpital).
Heathcare Service Location
Encounters[].Locations[].Type.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.NameString
ProbableName of the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].NameString
ProbableThe name of the location
Encounters[].Diagnosis[]String
ProbableList of Diagnoses associated with the visit.
SNOMED CT
Encounters[].Diagnosis[].CodeString
ProbableA code describing the associated diagnosis
Encounters[].Diagnosis[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].NameString
ProbableName of the associated diagnosis
Encounters[].ReasonForVisit[].CodeString
ProbableA code describing the reason for the visit (usually this is what the patient reports).
SNOMED CT
Encounters[].ReasonForVisit[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].NameString
ProbableName of the reason for the visit (usually this is what the patient reports)
FamilyHistory
FamilyHistoryTextString
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.CodeString
ReliableRequiredA code describing the family member's relationship (father, mother, maternal grandfather, etc.).
HL7 Family History Related Subjects
FamilyHistory[].Relation.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Relation.NameString
ReliableName of the family member's relationship (father, mother, maternal grandfather, etc.)
FamilyHistory[].Relation.Demographics.SexString
ProbableGender of the relative
-
Additional values may be added by Redox in the future.
-
FamilyHistory[].Relation.Demographics.DOBString
ProbableDate of Birth of the relative.
In YYYY-MM-DD format
FamilyHistory[].Relation.IsDeceasedBoolean
ProbableWhether or not the relative is deceased
FamilyHistory[].Problems[]String
ReliableA list of the relative's relevant health problems
FamilyHistory[].Problems[].CodeString
ReliableRequiredA code describing a particular problem experienced by the relative.
SNOMED CT
FamilyHistory[].Problems[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].NameString
ReliableName of a particular problem experienced by the relative
FamilyHistory[].Problems[].Type.CodeString
ReliableRequiredA code describing the general class of the problem. (disease, problem, etc.).
Problem Type Value Set
FamilyHistory[].Problems[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].Type.NameString
ReliableName of the general class of the problem. (disease, problem, etc.)
FamilyHistory[].Problems[].DateTimeString
ProbableThe time when the problem started.
ISO 8601 Format
FamilyHistory[].Problems[].AgeAtOnsetString
ProbableThe relative's age when the problem started
FamilyHistory[].Problems[].IsCauseOfDeathBoolean
ProbableFlag indicating whether or not this problem was the cause of death for the relative.
Immunizations
ImmunizationTextString
ProbableFree text form of the immunization summary
Immunizations[]Array of Objects
ReliableArray of immunizations for patient.
Immunizations[].DateTimeString
ReliableRequiredWhen the immunization was given.
ISO 8601 Format
Immunizations[].Route.CodeString
ProbableA code describing the way in which the immunization was delivered (intramuscular, oral, etc.).
Medication Route FDA Value Set
Immunizations[].Route.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.NameString
ProbableName of the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Product.ManufacturerString
ProbableName of organization that manufacture the immunization.
Free text
Immunizations[].Product.CodeString
ReliableRequiredA code describing the vaccination that was given.
CVX code system
Immunizations[].Product.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.NameString
ReliableName of the vaccination that was given
Immunizations[].Product.LotNumberString
ProbableThe lot number of the vaccine
Immunizations[].Dose.QuantityString
ProbableThe size of the dose
Immunizations[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
Insurances
InsurancesTextString
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.IDString
ProbableIdentifier of insurance plan
Insurances[].Plan.IDTypeString
ProbableID type of insurance plan
Insurances[].Plan.NameString
ProbableName of insurance plan
Insurances[].Plan.TypeString
PossibleType of insurance plan
Insurances[].MemberNumberString
PossiblePatient member number
Insurances[].Company.IDString
PossibleID of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.IDTypeString
PossibleID type of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.NameString
ProbableName of insurance company (payor)
Insurances[].Company.AddressObject
ProbableInsurance company's address
Insurances[].Company.Address.StreetAddressString
ProbableStreet address
Insurances[].Company.Address.CityString
ProbableCity
Insurances[].Company.Address.StateString
ProbableState
Insurances[].Company.Address.ZIPString
ProbableZIP
Insurances[].Company.Address.CountyString
PossibleCounty
Insurances[].Company.Address.CountryString
PossibleCountry
Insurances[].Company.PhoneNumberString
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Insurances[].GroupNumberString
ProbableInsurance policy group number
Insurances[].GroupNameString
PossibleInsurance policy group name.
Typically not available in ClinicalSummary.
Insurances[].EffectiveDateString
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Insurances[].ExpirationDateString
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Insurances[].PolicyNumberString
ProbableInsurance policy number
Insurances[].AgreementTypeString
PossibleType of insurance agreement.
Typically not available in ClinicalSummary.
Insurances[].CoverageTypeString
ProbableType of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Insurances[].InsuredObject
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[].IDString
PossibleID for the insured
Insurances[].Insured.Identifiers[].IDTypeString
PossibleType of ID.
E.g. MRN, EPI
Insurances[].Insured.LastNameString
PossibleLast name of the insured
Insurances[].Insured.MiddleNameString
PossibleMiddle name of the insured
Insurances[].Insured.FirstNameString
PossibleFirst name of the insured
Insurances[].Insured.SSNString
PossibleInsured's social security number
Insurances[].Insured.RelationshipString
PossibleRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.DOBString
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Insurances[].Insured.SexString
PossibleSex of the insured
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.AddressObject
ProbableAddress of the insured
Insurances[].Insured.Address.StreetAddressString
ProbableStreet address
Insurances[].Insured.Address.CityString
ProbableCity
Insurances[].Insured.Address.StateString
ProbableState
Insurances[].Insured.Address.ZIPString
ProbableZIP
Insurances[].Insured.Address.CountyString
PossibleCounty
Insurances[].Insured.Address.CountryString
PossibleCountry
MedicalEquipment
MedicalEquipmentTextString
ProbableFree text form of the medical equipment summary
MedicalEquipment[]String
ProbableA list of medical equipment that the patient uses (cane, pacemakers, etc.)
MedicalEquipment[].StatusString
ReliableRequiredThe current status of the equipment (active, completed, etc.)
MedicalEquipment[].StartDateString
ProbableWhen the equipment was first put into use.
ISO 8601 Format
MedicalEquipment[].QuantityString
ProbableThe number of products used
MedicalEquipment[].Product.CodeString
ProbableA code describing the actual product.
SNOMED CT
MedicalEquipment[].Product.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.NameString
ProbableName of the actual product.
Medications
MedicationsTextString
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[].PrescriptionBoolean
ReliableRequiredWhether the medication is a prescription.
For a prescription: true. For a patient reported med, or a med administered by a provider: false
Medications[].FreeTextSigString
PossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
Medications[].Dose.QuantityString
ProbableThe size of the dose for pills, capsules, etc.
Medications[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
Medications[].Rate.QuantityString
ProbableIf the medication is in liquid form, the rate at which it is administered
Medications[].Rate.UnitsString
ProbableUnits for the rate.
UCUM Units of Measure
Medications[].Route.CodeString
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
Medications[].Route.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.NameString
ProbableName of the method by which the medication is delivered
Medications[].StartDateString
ReliableRequiredWhen the medication was started.
ISO 8601 Format
Medications[].EndDateString
ProbableWhen the medication ended.
ISO 8601 Format
Medications[].Frequency.PeriodString
ProbableHow often the patient should be taking the medication.
UCUM Units of Measure
Medications[].Frequency.UnitString
ProbableUnits for how often the patient should be taking the medication
Medications[].IsPRNBoolean
ProbableWhether the medication is to be taken on an as-needed basis
Medications[].Product.CodeString
ReliableRequiredA code describing the actual medication given .
RxNorm
Medications[].Product.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.NameString
ReliableName of the actual medication given
PlanOfCare
PlanOfCareTextString
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[].CodeString
ProbableA code describing the test to be performed .
LOINC
PlanOfCare.Orders[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].NameString
ProbableName of the test to be performed
PlanOfCare.Orders[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Orders[].DateTimeISO Format
Probable
PlanOfCare.Procedures[]Array of Objects
ProbableFuture procedures.
PlanOfCare.Procedures[].CodeString
ProbableA code describing the planned procedure, such as an appendectomy or hip replacement .
SNOMED CT
PlanOfCare.Procedures[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].NameString
ProbableName of the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Procedures[].DateTimeISO Format
Probable
PlanOfCare.Encounters[]Array of Objects
ProbableAppointments and other upcoming encounters
PlanOfCare.Encounters[].CodeString
ProbableA code describing the planned encounter type .
SNOMED CT
PlanOfCare.Encounters[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].NameString
ProbableName of the planned encounter type
PlanOfCare.Encounters[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Encounters[].DateTimeString
Probable
PlanOfCare.MedicationAdministration[]Array of Objects
ProbablePlanned medication
PlanOfCare.MedicationAdministration[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.MedicationAdministration[].Dose.QuantityString
ProbableThe size of the dose for pills, capsules, etc.
PlanOfCare.MedicationAdministration[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Rate.QuantityString
ProbableIf the medication is not in does form, this is the rate at which is administered
PlanOfCare.MedicationAdministration[].Rate.UnitsString
ProbableUnits for the rate.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Route.CodeString
ProbableA code describing the method by which the medication is to be delivered.
Medication Route FDA Value Set
PlanOfCare.MedicationAdministration[].Route.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.NameString
ProbableName of the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].StartDateISO Format
ProbableWhen the medication was started
PlanOfCare.MedicationAdministration[].EndDateISO Format
ProbableWhen the medication ended
PlanOfCare.MedicationAdministration[].Frequency.PeriodString
ProbableHow often the patient should be taking the medication.
UCUM Units of measure
PlanOfCare.MedicationAdministration[].Frequency.UnitString
ProbableUnits for how often the patient should be taking the medication
PlanOfCare.MedicationAdministration[].Product.CodeString
ProbableA code describing the planned medication .
RxNorm
PlanOfCare.MedicationAdministration[].Product.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.NameString
ProbableName of the planned medication
PlanOfCare.Supplies[]Array of Objects
ProbableFuture supplies that a patient may be given, including implants.
PlanOfCare.Supplies[].CodeString
ProbableA code describing the planned product.
SNOMED CT
PlanOfCare.Supplies[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].NameString
ProbableName of the planned product
PlanOfCare.Supplies[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Supplies[].DateTimeISO 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[].CodeString
ProbableA code describing the planned activity.
SNOMED CT
PlanOfCare.Services[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].NameString
ProbableName of the planned activity.
PlanOfCare.Services[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Services[].DateTimeISO Format
ProbableThe scheduled time of the activity. .
ISO 8601 Format
Problems
ProblemsTextString
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[].StartDateString
ProbableWhen the problem was noticed.
ISO 8601 Format
Problems[].EndDateString
ProbableWhen the problem stopped (if it is not current).
ISO 8601 Format
Problems[].CodeString
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[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].NameString
ReliableName of the actual problem
Problems[].Category.CodeString
ReliableRequiredA code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.NameString
ReliableName of the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].HealthStatus.CodeString
ProbableA code describing the effect of the problem on the patient (chronically ill, in remission, etc.).
SNOMED-CT
Problems[].HealthStatus.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.NameString
ProbableName of the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].Status.CodeString
ProbableA code describing the current state of the problem (active, inactive, resolved).
HITSPProblemStatus
Problems[].Status.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Status.NameString
ProbableName of the current state of the problem (active, inactive, resolved)
Procedures
ProceduresTextString
ProbableFree text form of the procedures summary
ProceduresProbableA 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[].CodeString
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Observations[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].NameString
ProbableName of the procedure that was performed.
Procedures.Observations[].DateTimeProbableWhen the procedure was performed.
Procedures.Observations[].StatusProbableThe status of the procedure.
Procedures.Observations[].TargetSite.CodeString
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Observations[].TargetSite.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.NameString
ProbableName 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[].CodeString
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Procedures[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].NameString
ProbableName of the procedure that was performed.
Procedures.Procedures[].DateTimeProbableWhen the procedure was performed.
Procedures.Procedures[].StatusProbableThe status of the procedure.
Procedures.Procedures[].TargetSite.CodeString
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Procedures[].TargetSite.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.NameString
ProbableName 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[].CodeString
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Services[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].NameString
ProbableName of the procedure that was performed.
Procedures.Services[].DateTimeProbableWhen the procedure was performed.
Procedures.Services[].StatusProbableThe status of the procedure.
Results
ResultTextString
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[].CodeString
ReliableRequiredA code describing the test performed and resulted.
LOINC for Lab, SNOMED CT otherwise
Results[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].NameString
ReliableName of the test performed and resulted.
Results[].StatusString
ReliableRequiredThe status of the test (In Progress, Final)
Results[].Observations[]Array of Object
ReliableA list of corresponding observations for the test (result components)
Results[].Observations[].CodeString
ReliableRequiredA code describing the individual result component. .
LOINC for Lab, SNOMED CT otherwise
Results[].Observations[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].NameString
ReliableName of the individual result component.
Results[].Observations[].StatusString
ReliableRequiredThe status of the individual component. Some tests may have different components finish at different times. .
One of (In Progress, Final)
Results[].Observations[].InterpretationString
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
Results[].Observations[].DateTimeString
ReliableRequiredA specific date/time when the value was recorded.
ISO 8601 Format
Results[].Observations[].CodedValue.CodeString
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.CodeSystemString
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.CodeSystemNameString
PossibleCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.NameString
PossibleName of the individual result value.
Results[].Observations[].ValueString
ReliableRequiredThe measurement recorded for the result.
Results[].Observations[].ValueTypeString
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[].UnitsString
ReliableRequiredThe units of the measurement.
Only available when ValueType is PhysicalQuantity
Results[].Observations[].ReferenceRangeObject
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.LowNumeric
PossibleLower bound for a normal result
Results[].Observations[].ReferenceRange.HighNumeric
PossibleUpper bound for a normal result
Results[].Observations[].ReferenceRange.TextString
PossibleThe normal value for non-numeric results
SocialHistory
SocialHistoryTextString
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[].CodeString
ProbableA code describing a type of social history observation (exercise, alcohol intake, etc.) .
SNOMED CT
SocialHistory.Observations[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].NameString
ProbableName of a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].ValueObject
ProbableThe observed value
SocialHistory.Observations[].Value.CodeString
ProbableA code describing the observed value, if coded
SocialHistory.Observations[].Value.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.NameString
ProbableName of the observed value, if coded
SocialHistory.Observations[].ValueTextString
ProbableThe observed value, if uncoded
SocialHistory.Observations[].StartDateString
ProbableStart date of status
SocialHistory.Observations[].EndDateString
ProbableDate status ended. If this is null, the status is current.
SocialHistory.Pregnancy[]String
ProbableInformation about past and current pregnancies.
SocialHistory.Pregnancy[].StartDateString
ProbableWhen the pregnancy started.
ISO 8601 Format
SocialHistory.Pregnancy[].EndDateString
ProbableWhen the pregnancy ended.
ISO 8601 Format
SocialHistory.Pregnancy[].EstimatedDeliveryString
ProbableEstimate delivery date if pregnancy is still active.
SocialHistory.TobaccoUse[]String
ProbableContains tobacco use and smoking status observations
SocialHistory.TobaccoUse[].CodeString
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[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].NameString
ProbableName of the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].IsSmokingStatusBoolean
ProbableIdentifies this tobacco use entry as a smoking status.
If true, StartDate is the date the smoking status was observed.
SocialHistory.TobaccoUse[].StartDateString
ProbableStart date of status.
If IsSmokingStatus is true, this is the date the observation was made.
SocialHistory.TobaccoUse[].EndDateString
ProbableDate status ended. If this is null, the status is current.
VitalSigns
VitalSignsTextString
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[].DateTimeString
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[].CodeString
ReliableRequiredA code describing the type of vital sign being read (height, weight, blood pressure, etc.).
LOINC (HITSP Vital Sign Result Type).
VitalSigns[].Observations[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].NameString
ReliableName of the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].StatusString
ReliableRequiredThe status of the reading (usually completed)
VitalSigns[].Observations[].InterpretationString
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
VitalSigns[].Observations[].DateTimeString
ReliableRequiredThe date/time when the specific vital sign was recorded.
ISO 8601 Format
VitalSigns[].Observations[].ValueString
ReliableRequiredThe measurement recorded for the vital sign.
VitalSigns[].Observations[].UnitsString
ReliableRequiredThe units of the measurement.
UCUM Units of Measure
{
"Meta": {
"DataModel": "Clinical Summary",
"EventType": "PatientQueryResponse",
"EventDateTime": "2019-10-24T23:54:41.339Z",
"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"
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR",
"Type": null
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID",
"Type": null
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST",
"Type": null
}
],
"Demographics": {
"FirstName": "Timothy",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"County": "Green",
"Country": "US",
"ZIP": "53566"
},
"PhoneNumber": {
"Home": "+18088675301",
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Race": "White",
"Ethnicity": null,
"Religion": null,
"MaritalStatus": "Married"
}
}
},
"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"
},
"Code": "304253006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Do not resuscitate",
"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"
},
"Substance": {
"Code": "7982",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Penicillin G benzathine"
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Rash",
"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",
"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"
},
"Substance": {
"Code": "2670",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Codeine"
},
"Reaction": [
{
"Code": "267036007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Shortness of Breath",
"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"
},
"Substance": {
"Code": "1191",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Aspirin"
},
"Reaction": [
{
"Code": "247472004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Hives",
"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"
},
"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"
}
}
],
"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"
},
"Name": "Community Health and Hospitals"
}
],
"Diagnosis": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia"
}
],
"ReasonForVisit": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia"
}
]
}
],
"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",
"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",
"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"
},
"Product": {
"Manufacturer": "Health LS - Immuno Inc.",
"Code": "88",
"CodeSystem": "2.16.840.1.113883.6.59",
"CodeSystemName": "CVX",
"Name": "Influenza virus vaccine",
"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"
},
"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",
"LotNumber": null
},
"Dose": {
"Quantity": "50",
"Units": "mcg"
}
}
],
"InsurancesText": null,
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductable 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"
}
},
{
"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"
}
},
{
"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"
}
}
],
"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"
},
"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"
}
},
{
"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)"
},
"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"
}
}
],
"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",
"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",
"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",
"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"
},
"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"
}
}
],
"Supplies": [],
"Services": [
{
"Code": "427519008",
"CodeSystem": "2.16.840.1.113883.11.20.9.34",
"CodeSystemName": "patientEducationType",
"Name": "Caregiver",
"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",
"Category": {
"Code": "409586006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Complaint"
},
"HealthStatus": {
"Code": "162467007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Symptom Free"
},
"Status": {
"Code": "413322009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Resolved"
}
},
{
"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",
"Category": {
"Code": "409586006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Complaint"
},
"HealthStatus": {
"Code": "162467007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Symptom Free"
},
"Status": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
}
}
],
"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",
"DateTime": "20120807",
"Status": "active",
"TargetSite": {
"Code": "302539009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Entire hand (body structure)"
}
}
],
"Procedures": [
{
"Code": "168731009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Chest X-Ray",
"DateTime": "20120807",
"Status": "completed",
"TargetSite": {
"Code": "181608004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Entire chest wall (body structure)"
}
}
],
"Services": [
{
"Code": "123456",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Fake action",
"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",
"Status": "Final",
"Observations": [
{
"Code": "30313-1",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "HGB",
"Status": "Final",
"Interpretation": "Normal",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"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",
"Status": "Final",
"Interpretation": "Normal",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"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",
"Status": "Final",
"Interpretation": "Low",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"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",
"Status": null,
"Observations": [
{
"Code": "86243-3",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Color of Sputum",
"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"
},
"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",
"Value": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"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",
"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",
"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",
"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",
"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",
"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",
"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",
"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",
"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
Documentobject in the Header section, allowing you to specify a document author and a visit related to the document (if applicable). Note thatHeader.Document.IDis required.
Fields
Meta
Meta.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
E.g. New, Update
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
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[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
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.DirectAddressFromPossibleThe sender's Direct address, if one or both sides are using Direct messaging.
Header.DirectAddressToPossibleThe recipient's Direct address, if one or both sides are using Direct messaging.
Header.DocumentObject
ReliableAn object containing metadata about the document being pushed to the destination.
Header.Document.Author.IDString
ReliableID of the Provider responsible for the document.
This ID is often required for Inpatient Visits.
Header.Document.Author.IDTypeString
ReliableID type of the ID for the Provider responsible for the document
Header.Document.Author.TypeString
ReliableThe type of provider for this referral.
One of the following: "Referring Provider", "Referred To Provider", "Other", "Patient PCP"
Header.Document.Author.FirstNameString
PossibleFirst name of the Provider responsible for the document
Header.Document.Author.LastNameString
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.AddressObject
PossibleProvider's address
Header.Document.Author.Address.StreetAddressString
PossibleStreet address
Header.Document.Author.Address.CityString
PossibleCity
Header.Document.Author.Address.StateString
PossibleState
Header.Document.Author.Address.ZIPString
PossibleZIP
Header.Document.Author.Address.CountyString
PossibleCounty
Header.Document.Author.Address.CountryString
PossibleCountry
Header.Document.Author.EmailAddresses[]Array of Strings
ProbableProvider's email address(es)
Header.Document.Author.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Header.Document.Author.LocationObject
PossibleProvider's location
Header.Document.Author.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Author.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Header.Document.Author.Location.DepartmentString
PossibleDepartment
Header.Document.Author.Location.RoomString
PossibleRoom.
Example: 136
Header.Document.IDString
ReliableRequiredYour application's ID for the document
Header.Document.LocaleString
ReliableRequiredThe language of the document.
Header.Document.TitleString
ReliableRequiredThe title of the document.
Header.Document.DateTimeString
ReliableRequiredThe creation/publishing date/time of the document.
Header.Document.TypeString
ReliableRequiredThe type of document (Patient Summary, Visit Summary, etc.)
Header.Patient.Identifiers[]String
ReliableAn array of identifiers for the patient.
Header.Patient.Identifiers[].IDString
ReliableRequiredThe actual identifier for the patient.
Header.Patient.Identifiers[].IDTypeString
ReliableRequiredAn ID type associated with identifier (Medical Record Number, etc.)
Header.Patient.Identifiers[].TypeString
ReliableIf present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.
Header.Patient.Demographics.FirstNameString
ReliableRequiredPatient's first name
Header.Patient.Demographics.LastNameString
ReliableRequiredPatient's last name
Header.Patient.Demographics.DOBDate
ReliableRequiredPatient's date of birth.
In YYYY-MM-DD format
Header.Patient.Demographics.SSNString
ReliablePatient SSN
Header.Patient.Demographics.SexString
ReliableRequiredPatient gender
-
Additional values may be added by Redox in the future.
-
Header.Patient.Demographics.Address.StreetAddressString
Reliable
Header.Patient.Demographics.Address.CityString
Reliable
Header.Patient.Demographics.Address.StateString
Reliable
Header.Patient.Demographics.Address.CountyString
Reliable
Header.Patient.Demographics.Address.CountryString
Reliable
Header.Patient.Demographics.Address.ZIPString
Reliable
Header.Patient.Demographics.PhoneNumber.HomeString
Reliable
Header.Patient.Demographics.PhoneNumber.MobileString
Reliable
Header.Patient.Demographics.EmailAddresses[].AddressString
Reliable
Header.Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Header.Patient.Demographics.RaceString
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.EthnicityString
ReliableOne of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown
Header.Patient.Demographics.ReligionString
Reliable
Header.Patient.Demographics.MaritalStatusString
Reliable
-
Additional values may be added by Redox in the future.
-
Header.Document.VisitPossibleNote - visit fields are unlikely in PatientPush. The VisitPush event type should be used instead.
Header.Document.Visit.LocationObject
ReliableIf the document is tied to a visit, this is the location of the visit.
Header.Document.Visit.Location.TypeString
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Visit.Location.FacilityString
ReliableFacility.
Example: Community Hospital
Header.Document.Visit.Location.DepartmentString
ReliableDepartment
Header.Document.Visit.Location.RoomString
ReliableRoom.
Example: 136
Header.Document.Visit.StartDateTimeDateTime
ProbableIf the document is tied to a visit, this is the start date/time of the visit.
ISO 8601 Format
Header.Document.Visit.EndDateTimeString
ProbableIf the document is tied to a visit, this is the end date/time of the visit.
ISO 8601 Format
Header.Document.Visit.ReasonString
ProbableIf the document is tied to a visit, this is the the reason for visit.
AdvanceDirectives
AdvanceDirectives[]Array of Objects
Probable
AdvanceDirectives[].Type.CodeString
ReliableRequiredA code describing the type of advance directive (such as resuscitation).
SNOMED CT
AdvanceDirectives[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.NameString
ReliableName of the type of advance directive (such as resuscitation)
AdvanceDirectives[].CodeString
ReliableRequiredA code describing the value of the advance directive (such as 'do not resuscitate').
SNOMED CT
AdvanceDirectives[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].NameString
ReliableName of the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].StartDateDateTime
ReliableRequiredEffective start date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].EndDateDateTime
ProbableEffective end date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].ExternalReferenceString
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[].FirstNameString
Probable
AdvanceDirectives[].VerifiedBy[].LastNameString
Probable
AdvanceDirectives[].VerifiedBy[].CredentialsString
Probable
AdvanceDirectives[].VerifiedBy[].DateTimeString
Probable
AdvanceDirectives[].Custodians[]Array of Objects
ProbablePeople legally resposible for the advance directive document.
AdvanceDirectives[].Custodians[].FirstNameString
Probable
AdvanceDirectives[].Custodians[].LastNameString
Probable
AdvanceDirectives[].Custodians[].CredentialsString
Probable
AdvanceDirectives[].Custodians[].Address.StreetAddressString
Probable
AdvanceDirectives[].Custodians[].Address.CityString
Probable
AdvanceDirectives[].Custodians[].Address.StateString
Probable
AdvanceDirectives[].Custodians[].Address.CountryString
Probable
AdvanceDirectives[].Custodians[].Address.ZIPString
Probable
Allergies
Allergies[]Array of Objects
Probable
Allergies[].Type.CodeString
ReliableRequiredA code describing the type of allergy intolerance this is (food, drug, etc.).
SNOMED CT from Allergy/Adverse Event Type Value Set
Allergies[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.NameString
ReliableName of the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Substance.CodeString
ReliableRequired
Allergies[].Substance.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.NameString
ReliableName of the substance that the causes the alergy/intolerance
Allergies[].Reaction[]String
ProbableAll the reactions caused by this particular substance.
SNOMED CT
Allergies[].Reaction[].CodeString
ReliableRequiredA code describing the reaction caused by the allergy (dizziness, hives ,etc.).
SNOMED CT
Allergies[].Reaction[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].NameString
ReliableName of the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].Severity.CodeString
ReliableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT
Allergies[].Reaction[].Severity.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].Severity.NameString
ReliableName of a code for the severity of the reaction (moderate, severe, etc.)
Allergies[].Reaction[].TextString
ReliableFree text form of reactions to this substance, includes information that cannot be captured by coded value.
Allergies[].Severity.CodeString
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.CodeSystemString
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.CodeSystemNameString
PossibleCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Severity.NameString
PossibleName of a code for the severity of the reaction (moderate, severe, etc.).
Allergies[].Criticality.CodeString
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.CodeSystemString
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.CodeSystemNameString
PossibleCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Criticality.NameString
PossibleName of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
Allergies[].Status.CodeString
ReliableRequiredA code describing the current status of the allergy (active, historic, etc.).
SNOMED CT (Active, Inactive, Resolved)
Allergies[].Status.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Status.NameString
ReliableName of the current status of the allergy (active, historic, etc.)
Allergies[].StartDateString
ProbableWhen the allergy was first noted.
ISO 8601 Format
Allergies[].EndDateString
ProbableWhen the allergy was no longer a problem (if applicable).
ISO 8601 Format
Allergies[].CommentString
PossibleFree text comment about the allergy.
Encounters
Encounters[]Array of Objects
Probable
Encounters[].Identifiers[]Array of Objects
ProbableList of IDs specific to this encounter
Encounters[].Identifiers[].IDString
ProbableAn ID specific to this encounter
Encounters[].Identifiers[].IDTypeString
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Encounters[].Type.CodeString
ReliableRequiredA code describing the type of encounter (office visit, hospital, etc).
CPT-4
Encounters[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.NameString
ReliableName of the type of encounter (office visit, hospital, etc)
Encounters[].DateTimeDateTime
ReliableRequiredWhen the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present.
ISO 8601 Format
Encounters[].EndDateTimeDateTime
PossibleWhen the encounter was completed, if available.
ISO 8601 Format
Encounters[].Providers[].IDString
ProbableID of the Encounter Providers.
This ID is often required for Inpatient Visits.
Encounters[].Providers[].IDTypeString
ProbableID type of the ID for the Encounter Providers
Encounters[].Providers[].FirstNameString
PossibleFirst name of the Encounter Providers
Encounters[].Providers[].LastNameString
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[].AddressObject
PossibleProvider's address
Encounters[].Providers[].Address.StreetAddressString
PossibleStreet address
Encounters[].Providers[].Address.CityString
PossibleCity
Encounters[].Providers[].Address.StateString
PossibleState
Encounters[].Providers[].Address.ZIPString
PossibleZIP
Encounters[].Providers[].Address.CountyString
PossibleCounty
Encounters[].Providers[].Address.CountryString
PossibleCountry
Encounters[].Providers[].EmailAddresses[]Array of Strings
ProbableProvider's email address(es)
Encounters[].Providers[].PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Encounters[].Providers[].LocationObject
PossibleProvider's location
Encounters[].Providers[].Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Encounters[].Providers[].Location.FacilityString
PossibleFacility.
Example: Community Hospital
Encounters[].Providers[].Location.DepartmentString
PossibleDepartment
Encounters[].Providers[].Location.RoomString
PossibleRoom.
Example: 136
Encounters[].Providers[].Role.CodeString
ProbableA code describing the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.NameString
ProbableName of the role of the provider (pcp, general physician, etc.)
Encounters[].Locations[]String
Probable
Encounters[].Locations[].Address.StreetAddressString
Probable
Encounters[].Locations[].Address.CityString
Probable
Encounters[].Locations[].Address.StateString
Probable
Encounters[].Locations[].Address.CountryString
Probable
Encounters[].Locations[].Address.ZIPString
Probable
Encounters[].Locations[].Type.CodeString
ProbableA code describing the type of location where the patient was seen (clinic, urgent care, hostpital).
Heathcare Service Location
Encounters[].Locations[].Type.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.NameString
ProbableName of the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].NameString
ProbableThe name of the location
Encounters[].Diagnosis[]String
ProbableList of Diagnoses associated with the visit.
SNOMED CT
Encounters[].Diagnosis[].CodeString
ProbableA code describing the associated diagnosis
Encounters[].Diagnosis[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].NameString
ProbableName of the associated diagnosis
Encounters[].ReasonForVisit[].CodeString
ProbableA code describing the reason for the visit (usually this is what the patient reports).
SNOMED CT
Encounters[].ReasonForVisit[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].NameString
ProbableName of the reason for the visit (usually this is what the patient reports)
FamilyHistory
FamilyHistory[]Array of Objects
ProbableEach element of the FamilyHistory is one person in the patient's family.
FamilyHistory[].Relation.CodeString
ReliableRequiredA code describing the family member's relationship (father, mother, maternal grandfather, etc.).
HL7 Family History Related Subjects
FamilyHistory[].Relation.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Relation.NameString
ReliableName of the family member's relationship (father, mother, maternal grandfather, etc.)
FamilyHistory[].Relation.Demographics.SexString
ProbableGender of the relative
-
Additional values may be added by Redox in the future.
-
FamilyHistory[].Relation.Demographics.DOBString
ProbableDate of Birth of the relative.
In YYYY-MM-DD format
FamilyHistory[].Relation.IsDeceasedBoolean
ProbableWhether or not the relative is deceased
FamilyHistory[].Problems[]String
ReliableA list of the relative's relevant health problems
FamilyHistory[].Problems[].CodeString
ReliableRequiredA code describing a particular problem experienced by the relative.
SNOMED CT
FamilyHistory[].Problems[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].NameString
ReliableName of a particular problem experienced by the relative
FamilyHistory[].Problems[].Type.CodeString
ReliableRequiredA code describing the general class of the problem. (disease, problem, etc.).
Problem Type Value Set
FamilyHistory[].Problems[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].Type.NameString
ReliableName of the general class of the problem. (disease, problem, etc.)
FamilyHistory[].Problems[].DateTimeString
ProbableThe time when the problem started.
ISO 8601 Format
FamilyHistory[].Problems[].AgeAtOnsetString
ProbableThe relative's age when the problem started
FamilyHistory[].Problems[].IsCauseOfDeathBoolean
ProbableFlag indicating whether or not this problem was the cause of death for the relative.
Immunizations
Immunizations[]Array of Objects
ReliableArray of immunizations for patient.
Immunizations[].DateTimeString
ReliableRequiredWhen the immunization was given.
ISO 8601 Format
Immunizations[].Route.CodeString
ProbableA code describing the way in which the immunization was delivered (intramuscular, oral, etc.).
Medication Route FDA Value Set
Immunizations[].Route.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.NameString
ProbableName of the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Product.ManufacturerString
ProbableName of organization that manufacture the immunization.
Free text
Immunizations[].Product.CodeString
ReliableRequiredA code describing the vaccination that was given.
CVX code system
Immunizations[].Product.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.NameString
ReliableName of the vaccination that was given
Immunizations[].Product.LotNumberString
ProbableThe lot number of the vaccine
Immunizations[].Dose.QuantityString
ProbableThe size of the dose
Immunizations[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
Insurances
InsurancesTextString
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.IDString
ProbableIdentifier of insurance plan
Insurances[].Plan.IDTypeString
ProbableID type of insurance plan
Insurances[].Plan.NameString
ProbableName of insurance plan
Insurances[].Plan.TypeString
PossibleType of insurance plan
Insurances[].MemberNumberString
PossiblePatient member number
Insurances[].Company.IDString
PossibleID of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.IDTypeString
PossibleID type of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.NameString
ProbableName of insurance company (payor)
Insurances[].Company.AddressObject
ProbableInsurance company's address
Insurances[].Company.Address.StreetAddressString
ProbableStreet address
Insurances[].Company.Address.CityString
ProbableCity
Insurances[].Company.Address.StateString
ProbableState
Insurances[].Company.Address.ZIPString
ProbableZIP
Insurances[].Company.Address.CountyString
PossibleCounty
Insurances[].Company.Address.CountryString
PossibleCountry
Insurances[].Company.PhoneNumberString
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Insurances[].GroupNumberString
ProbableInsurance policy group number
Insurances[].GroupNameString
PossibleInsurance policy group name.
Typically not available in ClinicalSummary.
Insurances[].EffectiveDateString
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Insurances[].ExpirationDateString
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Insurances[].PolicyNumberString
ProbableInsurance policy number
Insurances[].AgreementTypeString
PossibleType of insurance agreement.
Typically not available in ClinicalSummary.
Insurances[].CoverageTypeString
ProbableType of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Insurances[].InsuredObject
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[].IDString
PossibleID for the insured
Insurances[].Insured.Identifiers[].IDTypeString
PossibleType of ID.
E.g. MRN, EPI
Insurances[].Insured.LastNameString
PossibleLast name of the insured
Insurances[].Insured.MiddleNameString
PossibleMiddle name of the insured
Insurances[].Insured.FirstNameString
PossibleFirst name of the insured
Insurances[].Insured.SSNString
PossibleInsured's social security number
Insurances[].Insured.RelationshipString
PossibleRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.DOBString
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Insurances[].Insured.SexString
PossibleSex of the insured
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.AddressObject
ProbableAddress of the insured
Insurances[].Insured.Address.StreetAddressString
ProbableStreet address
Insurances[].Insured.Address.CityString
ProbableCity
Insurances[].Insured.Address.StateString
ProbableState
Insurances[].Insured.Address.ZIPString
ProbableZIP
Insurances[].Insured.Address.CountyString
PossibleCounty
Insurances[].Insured.Address.CountryString
PossibleCountry
MedicalEquipment
MedicalEquipment[]String
ProbableA list of medical equipment that the patient uses (cane, pacemakers, etc.)
MedicalEquipment[].StatusString
ReliableRequiredThe current status of the equipment (active, completed, etc.)
MedicalEquipment[].StartDateString
ProbableWhen the equipment was first put into use.
ISO 8601 Format
MedicalEquipment[].QuantityString
ProbableThe number of products used
MedicalEquipment[].Product.CodeString
ProbableA code describing the actual product.
SNOMED CT
MedicalEquipment[].Product.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.NameString
ProbableName of the actual product.
Medications
Medications[]Array of Objects
Probable
Medications[].PrescriptionBoolean
ReliableRequiredWhether the medication is a prescription.
For a prescription: true. For a patient reported med, or a med administered by a provider: false
Medications[].FreeTextSigString
PossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
Medications[].Dose.QuantityString
ProbableThe size of the dose for pills, capsules, etc.
Medications[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
Medications[].Rate.QuantityString
ProbableIf the medication is in liquid form, the rate at which it is administered
Medications[].Rate.UnitsString
ProbableUnits for the rate.
UCUM Units of Measure
Medications[].Route.CodeString
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
Medications[].Route.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.NameString
ProbableName of the method by which the medication is delivered
Medications[].StartDateString
ReliableRequiredWhen the medication was started.
ISO 8601 Format
Medications[].EndDateString
ProbableWhen the medication ended.
ISO 8601 Format
Medications[].Frequency.PeriodString
ProbableHow often the patient should be taking the medication.
UCUM Units of Measure
Medications[].Frequency.UnitString
ProbableUnits for how often the patient should be taking the medication
Medications[].IsPRNBoolean
ProbableWhether the medication is to be taken on an as-needed basis
Medications[].Product.CodeString
ReliableRequiredA code describing the actual medication given .
RxNorm
Medications[].Product.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.NameString
ReliableName of the actual medication given
PlanOfCare
PlanOfCare.Orders[]Array of Objects
ProbableFuture lab tests or other diagnostic procedures.
PlanOfCare.Orders[].CodeString
ProbableA code describing the test to be performed .
LOINC
PlanOfCare.Orders[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].NameString
ProbableName of the test to be performed
PlanOfCare.Orders[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Orders[].DateTimeISO Format
Probable
PlanOfCare.Procedures[]Array of Objects
ProbableFuture procedures.
PlanOfCare.Procedures[].CodeString
ProbableA code describing the planned procedure, such as an appendectomy or hip replacement .
SNOMED CT
PlanOfCare.Procedures[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].NameString
ProbableName of the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Procedures[].DateTimeISO Format
Probable
PlanOfCare.Encounters[]Array of Objects
ProbableAppointments and other upcoming encounters
PlanOfCare.Encounters[].CodeString
ProbableA code describing the planned encounter type .
SNOMED CT
PlanOfCare.Encounters[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].NameString
ProbableName of the planned encounter type
PlanOfCare.Encounters[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Encounters[].DateTimeString
Probable
PlanOfCare.MedicationAdministration[]Array of Objects
ProbablePlanned medication
PlanOfCare.MedicationAdministration[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.MedicationAdministration[].Dose.QuantityString
ProbableThe size of the dose for pills, capsules, etc.
PlanOfCare.MedicationAdministration[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Rate.QuantityString
ProbableIf the medication is not in does form, this is the rate at which is administered
PlanOfCare.MedicationAdministration[].Rate.UnitsString
ProbableUnits for the rate.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Route.CodeString
ProbableA code describing the method by which the medication is to be delivered.
Medication Route FDA Value Set
PlanOfCare.MedicationAdministration[].Route.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.NameString
ProbableName of the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].StartDateISO Format
ProbableWhen the medication was started
PlanOfCare.MedicationAdministration[].EndDateISO Format
ProbableWhen the medication ended
PlanOfCare.MedicationAdministration[].Frequency.PeriodString
ProbableHow often the patient should be taking the medication.
UCUM Units of measure
PlanOfCare.MedicationAdministration[].Frequency.UnitString
ProbableUnits for how often the patient should be taking the medication
PlanOfCare.MedicationAdministration[].Product.CodeString
ProbableA code describing the planned medication .
RxNorm
PlanOfCare.MedicationAdministration[].Product.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.NameString
ProbableName of the planned medication
PlanOfCare.Supplies[]Array of Objects
ProbableFuture supplies that a patient may be given, including implants.
PlanOfCare.Supplies[].CodeString
ProbableA code describing the planned product.
SNOMED CT
PlanOfCare.Supplies[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].NameString
ProbableName of the planned product
PlanOfCare.Supplies[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Supplies[].DateTimeISO 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[].CodeString
ProbableA code describing the planned activity.
SNOMED CT
PlanOfCare.Services[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].NameString
ProbableName of the planned activity.
PlanOfCare.Services[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Services[].DateTimeISO Format
ProbableThe scheduled time of the activity. .
ISO 8601 Format
Problems
Problems[]Array of Objects
ReliableAn array of all of patient relevant problems, current and historical.
Problems[].StartDateString
ProbableWhen the problem was noticed.
ISO 8601 Format
Problems[].EndDateString
ProbableWhen the problem stopped (if it is not current).
ISO 8601 Format
Problems[].CodeString
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[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].NameString
ReliableName of the actual problem
Problems[].Category.CodeString
ReliableRequiredA code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.NameString
ReliableName of the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].HealthStatus.CodeString
ProbableA code describing the effect of the problem on the patient (chronically ill, in remission, etc.).
SNOMED-CT
Problems[].HealthStatus.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.NameString
ProbableName of the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].Status.CodeString
ProbableA code describing the current state of the problem (active, inactive, resolved).
HITSPProblemStatus
Problems[].Status.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Status.NameString
ProbableName of the current state of the problem (active, inactive, resolved)
Procedures
ProceduresProbableA 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[].CodeString
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Observations[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].NameString
ProbableName of the procedure that was performed.
Procedures.Observations[].DateTimeProbableWhen the procedure was performed.
Procedures.Observations[].StatusProbableThe status of the procedure.
Procedures.Observations[].TargetSite.CodeString
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Observations[].TargetSite.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.NameString
ProbableName 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[].CodeString
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Procedures[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].NameString
ProbableName of the procedure that was performed.
Procedures.Procedures[].DateTimeProbableWhen the procedure was performed.
Procedures.Procedures[].StatusProbableThe status of the procedure.
Procedures.Procedures[].TargetSite.CodeString
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Procedures[].TargetSite.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.NameString
ProbableName 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[].CodeString
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Services[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].NameString
ProbableName of the procedure that was performed.
Procedures.Services[].DateTimeProbableWhen the procedure was performed.
Procedures.Services[].StatusProbableThe status of the procedure.
Results
Results[]ProbableArray of test results for the patient. This can include laboratory results, imaging results, and procedure results.
Results[].CodeString
ReliableRequiredA code describing the test performed and resulted.
LOINC for Lab, SNOMED CT otherwise
Results[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].NameString
ReliableName of the test performed and resulted.
Results[].StatusString
ReliableRequiredThe status of the test (In Progress, Final)
Results[].Observations[]Array of Object
ReliableA list of corresponding observations for the test (result components)
Results[].Observations[].CodeString
ReliableRequiredA code describing the individual result component. .
LOINC for Lab, SNOMED CT otherwise
Results[].Observations[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].NameString
ReliableName of the individual result component.
Results[].Observations[].StatusString
ReliableRequiredThe status of the individual component. Some tests may have different components finish at different times. .
One of (In Progress, Final)
Results[].Observations[].InterpretationString
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
Results[].Observations[].DateTimeString
ReliableRequiredA specific date/time when the value was recorded.
ISO 8601 Format
Results[].Observations[].CodedValue.CodeString
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.CodeSystemString
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.CodeSystemNameString
PossibleCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.NameString
PossibleName of the individual result value.
Results[].Observations[].ValueString
ReliableRequiredThe measurement recorded for the result.
Results[].Observations[].ValueTypeString
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[].UnitsString
ReliableRequiredThe units of the measurement.
Only available when ValueType is PhysicalQuantity
Results[].Observations[].ReferenceRangeObject
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.LowNumeric
PossibleLower bound for a normal result
Results[].Observations[].ReferenceRange.HighNumeric
PossibleUpper bound for a normal result
Results[].Observations[].ReferenceRange.TextString
PossibleThe normal value for non-numeric results
SocialHistory
SocialHistory.Observations[]String
ProbableGeneric observations about the patient's social hisotry that don't fall into the smoking or pregnancy categories.
SocialHistory.Observations[].CodeString
ProbableA code describing a type of social history observation (exercise, alcohol intake, etc.) .
SNOMED CT
SocialHistory.Observations[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].NameString
ProbableName of a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].ValueObject
ProbableThe observed value
SocialHistory.Observations[].Value.CodeString
ProbableA code describing the observed value, if coded
SocialHistory.Observations[].Value.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.NameString
ProbableName of the observed value, if coded
SocialHistory.Observations[].ValueTextString
ProbableThe observed value, if uncoded
SocialHistory.Observations[].StartDateString
ProbableStart date of status
SocialHistory.Observations[].EndDateString
ProbableDate status ended. If this is null, the status is current.
SocialHistory.Pregnancy[]String
ProbableInformation about past and current pregnancies.
SocialHistory.Pregnancy[].StartDateString
ProbableWhen the pregnancy started.
ISO 8601 Format
SocialHistory.Pregnancy[].EndDateString
ProbableWhen the pregnancy ended.
ISO 8601 Format
SocialHistory.Pregnancy[].EstimatedDeliveryString
ProbableEstimate delivery date if pregnancy is still active.
SocialHistory.TobaccoUse[]String
ProbableContains tobacco use and smoking status observations
SocialHistory.TobaccoUse[].CodeString
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[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].NameString
ProbableName of the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].IsSmokingStatusBoolean
ProbableIdentifies this tobacco use entry as a smoking status.
If true, StartDate is the date the smoking status was observed.
SocialHistory.TobaccoUse[].StartDateString
ProbableStart date of status.
If IsSmokingStatus is true, this is the date the observation was made.
SocialHistory.TobaccoUse[].EndDateString
ProbableDate status ended. If this is null, the status is current.
VitalSigns
VitalSigns[]String
ProbableAn array of groups of vital signs.
VitalSigns[].DateTimeString
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[].CodeString
ReliableRequiredA code describing the type of vital sign being read (height, weight, blood pressure, etc.).
LOINC (HITSP Vital Sign Result Type).
VitalSigns[].Observations[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].NameString
ReliableName of the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].StatusString
ReliableRequiredThe status of the reading (usually completed)
VitalSigns[].Observations[].InterpretationString
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
VitalSigns[].Observations[].DateTimeString
ReliableRequiredThe date/time when the specific vital sign was recorded.
ISO 8601 Format
VitalSigns[].Observations[].ValueString
ReliableRequiredThe measurement recorded for the vital sign.
VitalSigns[].Observations[].UnitsString
ReliableRequiredThe units of the measurement.
UCUM Units of Measure
{
"Meta": {
"DataModel": "Clinical Summary",
"EventType": "PatientPush",
"EventDateTime": "2019-10-24T23:54:41.339Z",
"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": "pat.granite@direct.redoxengine.com",
"DirectAddressTo": "john.slate@direct.redoxengine.com",
"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",
"Visit": {
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"Room": "136"
},
"StartDateTime": "2019-10-24T23:54:41.751Z",
"EndDateTime": "2019-10-24T23:54:41.751Z",
"Reason": "Annual Physical"
}
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR",
"Type": null
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID",
"Type": null
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST",
"Type": null
}
],
"Demographics": {
"FirstName": "Timothy",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"County": "Green",
"Country": "US",
"ZIP": "53566"
},
"PhoneNumber": {
"Home": "+18088675301",
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Race": "White",
"Ethnicity": null,
"Religion": null,
"MaritalStatus": "Married"
}
}
},
"AdvanceDirectives": [
{
"Type": {
"Code": "304251008",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Resuscitation"
},
"Code": "304253006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Do not resuscitate",
"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"
}
}
]
}
],
"Allergies": [
{
"Type": {
"Code": "419511003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Propensity to adverse reaction to drug"
},
"Substance": {
"Code": "7982",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Penicillin G benzathine"
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Rash",
"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",
"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"
},
"Substance": {
"Code": "2670",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Codeine"
},
"Reaction": [
{
"Code": "267036007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Shortness of Breath",
"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"
},
"Substance": {
"Code": "1191",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Aspirin"
},
"Reaction": [
{
"Code": "247472004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Hives",
"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
}
],
"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"
},
"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"
}
}
],
"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"
},
"Name": "Community Health and Hospitals"
}
],
"Diagnosis": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia"
}
],
"ReasonForVisit": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia"
}
]
}
],
"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",
"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",
"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
}
]
}
],
"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"
},
"Product": {
"Manufacturer": "Health LS - Immuno Inc.",
"Code": "88",
"CodeSystem": "2.16.840.1.113883.6.59",
"CodeSystemName": "CVX",
"Name": "Influenza virus vaccine",
"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"
},
"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",
"LotNumber": null
},
"Dose": {
"Quantity": "50",
"Units": "mcg"
}
}
],
"InsurancesText": null,
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductable 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
}
}
}
],
"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"
}
},
{
"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"
}
},
{
"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"
}
}
],
"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"
},
"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"
}
},
{
"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)"
},
"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"
}
}
],
"PlanOfCare": {
"Orders": [
{
"Code": "624-7",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": null,
"Name": "Sputum Culture",
"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",
"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",
"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"
},
"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"
}
}
],
"Supplies": [],
"Services": [
{
"Code": "427519008",
"CodeSystem": "2.16.840.1.113883.11.20.9.34",
"CodeSystemName": "patientEducationType",
"Name": "Caregiver",
"Status": "Intent",
"DateTime": null
}
]
},
"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",
"Category": {
"Code": "409586006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Complaint"
},
"HealthStatus": {
"Code": "162467007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Symptom Free"
},
"Status": {
"Code": "413322009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Resolved"
}
},
{
"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",
"Category": {
"Code": "409586006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Complaint"
},
"HealthStatus": {
"Code": "162467007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Symptom Free"
},
"Status": {
"Code": "55561003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Active"
}
}
],
"Procedures": {
"Observations": [
{
"Code": "123456",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Fake observation",
"DateTime": "20120807",
"Status": "active",
"TargetSite": {
"Code": "302539009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Entire hand (body structure)"
}
}
],
"Procedures": [
{
"Code": "168731009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Chest X-Ray",
"DateTime": "20120807",
"Status": "completed",
"TargetSite": {
"Code": "181608004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Entire chest wall (body structure)"
}
}
],
"Services": [
{
"Code": "123456",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED-CT",
"Name": "Fake action",
"DateTime": "20120807",
"Status": "aborted"
}
]
},
"Results": [
{
"Code": "43789009",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "CBC WO DIFFERENTIAL",
"Status": "Final",
"Observations": [
{
"Code": "30313-1",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "HGB",
"Status": "Final",
"Interpretation": "Normal",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"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",
"Status": "Final",
"Interpretation": "Normal",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"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",
"Status": "Final",
"Interpretation": "Low",
"DateTime": "2012-08-10T14:00:00.000Z",
"CodedValue": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"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",
"Status": null,
"Observations": [
{
"Code": "86243-3",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Color of Sputum",
"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"
},
"Value": "Green",
"ValueType": "Code",
"Units": null,
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
}
}
]
}
],
"SocialHistory": {
"Observations": [
{
"Code": "160573003",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Alcohol Consumption",
"Value": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"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",
"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",
"IsSmokingStatus": false,
"StartDate": "2005-05-01",
"EndDate": "2008-09-01"
}
]
},
"VitalSigns": [
{
"DateTime": "1999-11-14T00:00:00.000Z",
"Observations": [
{
"Code": "8302-2",
"CodeSystem": "2.16.840.1.113883.6.1",
"CodeSystemName": "LOINC",
"Name": "Height",
"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",
"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",
"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",
"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",
"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",
"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.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
E.g. New, Update
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
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[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
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[].IDString
ReliableRequiredID of the Patient
Patient.Identifiers[].IDTypeString
ReliableRequiredID Type for the corresponding ID of this patient (ie. MRN, EHRID)
Visit
Visit.VisitNumberString
ReliableID for the patient visit/encounter. Either this or a timeframe is required to accurately locate a visit.
Visit.StartDateTimeISO 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.EndDateTimeISO Format
ProbableEnd of the timeframe for which to request visit summaries.
ISO 8601 Format
{
"Meta": {
"DataModel": "Clinical Summary",
"EventType": "VisitQuery",
"EventDateTime": "2019-10-24T23:54:41.339Z",
"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.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
E.g. New, Update
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
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[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
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.DocumentObject
ReliableAn object containing metadata about the document being pushed to the destination.
Header.Document.Author.IDString
ReliableID of the Provider responsible for the document.
This ID is often required for Inpatient Visits.
Header.Document.Author.IDTypeString
ReliableID type of the ID for the Provider responsible for the document
Header.Document.Author.TypeString
ReliableThe type of provider for this referral.
One of the following: "Referring Provider", "Referred To Provider", "Other", "Patient PCP"
Header.Document.Author.FirstNameString
PossibleFirst name of the Provider responsible for the document
Header.Document.Author.LastNameString
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.AddressObject
PossibleProvider's address
Header.Document.Author.Address.StreetAddressString
PossibleStreet address
Header.Document.Author.Address.CityString
PossibleCity
Header.Document.Author.Address.StateString
PossibleState
Header.Document.Author.Address.ZIPString
PossibleZIP
Header.Document.Author.Address.CountyString
PossibleCounty
Header.Document.Author.Address.CountryString
PossibleCountry
Header.Document.Author.EmailAddresses[]Array of Strings
ProbableProvider's email address(es)
Header.Document.Author.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Header.Document.Author.LocationObject
PossibleProvider's location
Header.Document.Author.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Author.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Header.Document.Author.Location.DepartmentString
PossibleDepartment
Header.Document.Author.Location.RoomString
PossibleRoom.
Example: 136
Header.Document.IDString
ReliableRequiredYour application's ID for the document
Header.Document.LocaleString
ReliableRequiredThe language of the document.
Header.Document.TitleString
ReliableRequiredThe title of the document.
Header.Document.DateTimeString
ReliableRequiredThe creation/publishing date/time of the document.
Header.Document.TypeString
ReliableRequiredThe type of document (Patient Summary, Visit Summary, etc.)
Header.Patient.Identifiers[]String
ReliableAn array of identifiers for the patient.
Header.Patient.Identifiers[].IDString
ReliableRequiredThe actual identifier for the patient.
Header.Patient.Identifiers[].IDTypeString
ReliableRequiredAn ID type associated with identifier (Medical Record Number, etc.)
Header.Patient.Identifiers[].TypeString
ReliableIf present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.
Header.Patient.Demographics.FirstNameString
ReliableRequiredPatient's first name
Header.Patient.Demographics.LastNameString
ReliableRequiredPatient's last name
Header.Patient.Demographics.DOBDate
ReliableRequiredPatient's date of birth.
In YYYY-MM-DD format
Header.Patient.Demographics.SSNString
ReliablePatient SSN
Header.Patient.Demographics.SexString
ReliableRequiredPatient gender
-
Additional values may be added by Redox in the future.
-
Header.Patient.Demographics.Address.StreetAddressString
Reliable
Header.Patient.Demographics.Address.CityString
Reliable
Header.Patient.Demographics.Address.StateString
Reliable
Header.Patient.Demographics.Address.CountyString
Reliable
Header.Patient.Demographics.Address.CountryString
Reliable
Header.Patient.Demographics.Address.ZIPString
Reliable
Header.Patient.Demographics.PhoneNumber.HomeString
Reliable
Header.Patient.Demographics.PhoneNumber.MobileString
Reliable
Header.Patient.Demographics.EmailAddresses[].AddressString
Reliable
Header.Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Header.Patient.Demographics.RaceString
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.EthnicityString
ReliableOne of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown
Header.Patient.Demographics.ReligionString
Reliable
Header.Patient.Demographics.MaritalStatusString
Reliable
-
Additional values may be added by Redox in the future.
-
Header.Document.Visit.LocationObject
ReliableIf the document is tied to a visit, this is the location of the visit.
Header.Document.Visit.Location.TypeString
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Header.Document.Visit.Location.FacilityString
ReliableFacility.
Example: Community Hospital
Header.Document.Visit.Location.DepartmentString
ReliableDepartment
Header.Document.Visit.Location.RoomString
ReliableRoom.
Example: 136
Header.Document.Visit.StartDateTimeDateTime
ProbableIf the document is tied to a visit, this is the start date/time of the visit.
ISO 8601 Format
Header.Document.Visit.EndDateTimeString
ProbableIf the document is tied to a visit, this is the end date/time of the visit.
ISO 8601 Format
Header.Document.Visit.ReasonString
ProbableIf the document is tied to a visit, this is the the reason for visit.
Header.Document.Visit.VisitNumberString
ReliableRequiredID for the patient visit/encounter.
AdvanceDirectives
AdvanceDirectivesTextString
ProbableFree text form of the advance directives summary
AdvanceDirectives[]Array of Objects
Probable
AdvanceDirectives[].Type.CodeString
ReliableRequiredA code describing the type of advance directive (such as resuscitation).
SNOMED CT
AdvanceDirectives[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].Type.NameString
ReliableName of the type of advance directive (such as resuscitation)
AdvanceDirectives[].CodeString
ReliableRequiredA code describing the value of the advance directive (such as 'do not resuscitate').
SNOMED CT
AdvanceDirectives[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
AdvanceDirectives[].NameString
ReliableName of the value of the advance directive (such as 'do not resuscitate')
AdvanceDirectives[].StartDateDateTime
ReliableRequiredEffective start date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].EndDateDateTime
ProbableEffective end date of the advance directive.
ISO 8601 Format
AdvanceDirectives[].ExternalReferenceString
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[].FirstNameString
Probable
AdvanceDirectives[].VerifiedBy[].LastNameString
Probable
AdvanceDirectives[].VerifiedBy[].CredentialsString
Probable
AdvanceDirectives[].VerifiedBy[].DateTimeString
Probable
AdvanceDirectives[].Custodians[]Array of Objects
ProbablePeople legally resposible for the advance directive document.
AdvanceDirectives[].Custodians[].FirstNameString
Probable
AdvanceDirectives[].Custodians[].LastNameString
Probable
AdvanceDirectives[].Custodians[].CredentialsString
Probable
AdvanceDirectives[].Custodians[].Address.StreetAddressString
Probable
AdvanceDirectives[].Custodians[].Address.CityString
Probable
AdvanceDirectives[].Custodians[].Address.StateString
Probable
AdvanceDirectives[].Custodians[].Address.CountryString
Probable
AdvanceDirectives[].Custodians[].Address.ZIPString
Probable
Allergies
AllergyTextString
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.CodeString
ReliableRequiredA code describing the type of allergy intolerance this is (food, drug, etc.).
SNOMED CT from Allergy/Adverse Event Type Value Set
Allergies[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Type.NameString
ReliableName of the type of allergy intolerance this is (food, drug, etc.)
Allergies[].Substance.CodeString
ReliableRequired
Allergies[].Substance.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Substance.NameString
ReliableName of the substance that the causes the alergy/intolerance
Allergies[].Reaction[]String
ProbableAll the reactions caused by this particular substance.
SNOMED CT
Allergies[].Reaction[].CodeString
ReliableRequiredA code describing the reaction caused by the allergy (dizziness, hives ,etc.).
SNOMED CT
Allergies[].Reaction[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].NameString
ReliableName of the reaction caused by the allergy (dizziness, hives ,etc.)
Allergies[].Reaction[].Severity.CodeString
ReliableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT
Allergies[].Reaction[].Severity.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Reaction[].Severity.NameString
ReliableName of a code for the severity of the reaction (moderate, severe, etc.)
Allergies[].Reaction[].TextString
ReliableFree text form of reactions to this substance, includes information that cannot be captured by coded value.
Allergies[].Severity.CodeString
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.CodeSystemString
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.CodeSystemNameString
PossibleCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Severity.NameString
PossibleName of a code for the severity of the reaction (moderate, severe, etc.).
Allergies[].Criticality.CodeString
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.CodeSystemString
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.CodeSystemNameString
PossibleCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Criticality.NameString
PossibleName of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
Allergies[].Status.CodeString
ReliableRequiredA code describing the current status of the allergy (active, historic, etc.).
SNOMED CT (Active, Inactive, Resolved)
Allergies[].Status.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Allergies[].Status.NameString
ReliableName of the current status of the allergy (active, historic, etc.)
Allergies[].StartDateString
ProbableWhen the allergy was first noted.
ISO 8601 Format
Allergies[].EndDateString
ProbableWhen the allergy was no longer a problem (if applicable).
ISO 8601 Format
Allergies[].CommentString
PossibleFree text comment about the allergy.
Assessment
AssessmentTextString
ProbableFree text of the clinician's conclusions and working assumptions that will guide treatment of the patient.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Assessment.Diagnoses[]Array of Objects
ProbableAn array of diagnoses
Assessment.Diagnoses[].ValueString
ProbableThe diagnosis as free text
Assessment.Diagnoses[].DateTimeISO Format
ProbableWhen the diagnosis was recorded.
ISO 8601 Format
Assessment.Diagnoses[].IsNegativeIndicatorBoolean
ProbableAbsent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true
Assessment.Diagnoses[].Codes[].CodeString
ProbableA code describing the diagnosis.
ICD9, ICD10, HCPC, CPT, SNOMED CT
Assessment.Diagnoses[].Codes[].CodeSystemString
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.
Assessment.Diagnoses[].Codes[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Assessment.Diagnoses[].Codes[].NameString
ProbableName of the diagnosis
ChiefComplaint
ChiefComplaintTextString
ReliableRequiredFree text chief complaint with any documented exposition.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Encounters
EncountersTextString
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[].IDString
ProbableAn ID specific to this encounter
Encounters[].Identifiers[].IDTypeString
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Encounters[].Type.CodeString
ReliableRequiredA code describing the type of encounter (office visit, hospital, etc).
CPT-4
Encounters[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Type.NameString
ReliableName of the type of encounter (office visit, hospital, etc)
Encounters[].DateTimeDateTime
ReliableRequiredWhen the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present.
ISO 8601 Format
Encounters[].EndDateTimeDateTime
PossibleWhen the encounter was completed, if available.
ISO 8601 Format
Encounters[].Providers[].IDString
ProbableID of the Encounter Providers.
This ID is often required for Inpatient Visits.
Encounters[].Providers[].IDTypeString
ProbableID type of the ID for the Encounter Providers
Encounters[].Providers[].FirstNameString
PossibleFirst name of the Encounter Providers
Encounters[].Providers[].LastNameString
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[].AddressObject
PossibleProvider's address
Encounters[].Providers[].Address.StreetAddressString
PossibleStreet address
Encounters[].Providers[].Address.CityString
PossibleCity
Encounters[].Providers[].Address.StateString
PossibleState
Encounters[].Providers[].Address.ZIPString
PossibleZIP
Encounters[].Providers[].Address.CountyString
PossibleCounty
Encounters[].Providers[].Address.CountryString
PossibleCountry
Encounters[].Providers[].EmailAddresses[]Array of Strings
ProbableProvider's email address(es)
Encounters[].Providers[].PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Encounters[].Providers[].LocationObject
PossibleProvider's location
Encounters[].Providers[].Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Encounters[].Providers[].Location.FacilityString
PossibleFacility.
Example: Community Hospital
Encounters[].Providers[].Location.DepartmentString
PossibleDepartment
Encounters[].Providers[].Location.RoomString
PossibleRoom.
Example: 136
Encounters[].Providers[].Role.CodeString
ProbableA code describing the role of the provider (pcp, general physician, etc.)
Encounters[].Providers[].Role.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Providers[].Role.NameString
ProbableName of the role of the provider (pcp, general physician, etc.)
Encounters[].Locations[]String
Probable
Encounters[].Locations[].Address.StreetAddressString
Probable
Encounters[].Locations[].Address.CityString
Probable
Encounters[].Locations[].Address.StateString
Probable
Encounters[].Locations[].Address.CountryString
Probable
Encounters[].Locations[].Address.ZIPString
Probable
Encounters[].Locations[].Type.CodeString
ProbableA code describing the type of location where the patient was seen (clinic, urgent care, hostpital).
Heathcare Service Location
Encounters[].Locations[].Type.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Locations[].Type.NameString
ProbableName of the type of location where the patient was seen (clinic, urgent care, hostpital)
Encounters[].Locations[].NameString
ProbableThe name of the location
Encounters[].Diagnosis[]String
ProbableList of Diagnoses associated with the visit.
SNOMED CT
Encounters[].Diagnosis[].CodeString
ProbableA code describing the associated diagnosis
Encounters[].Diagnosis[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].Diagnosis[].NameString
ProbableName of the associated diagnosis
Encounters[].ReasonForVisit[].CodeString
ProbableA code describing the reason for the visit (usually this is what the patient reports).
SNOMED CT
Encounters[].ReasonForVisit[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Encounters[].ReasonForVisit[].NameString
ProbableName of the reason for the visit (usually this is what the patient reports)
FamilyHistory
FamilyHistoryTextString
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.CodeString
ReliableRequiredA code describing the family member's relationship (father, mother, maternal grandfather, etc.).
HL7 Family History Related Subjects
FamilyHistory[].Relation.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Relation.NameString
ReliableName of the family member's relationship (father, mother, maternal grandfather, etc.)
FamilyHistory[].Relation.Demographics.SexString
ProbableGender of the relative
-
Additional values may be added by Redox in the future.
-
FamilyHistory[].Relation.Demographics.DOBString
ProbableDate of Birth of the relative.
In YYYY-MM-DD format
FamilyHistory[].Relation.IsDeceasedBoolean
ProbableWhether or not the relative is deceased
FamilyHistory[].Problems[]String
ReliableA list of the relative's relevant health problems
FamilyHistory[].Problems[].CodeString
ReliableRequiredA code describing a particular problem experienced by the relative.
SNOMED CT
FamilyHistory[].Problems[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].NameString
ReliableName of a particular problem experienced by the relative
FamilyHistory[].Problems[].Type.CodeString
ReliableRequiredA code describing the general class of the problem. (disease, problem, etc.).
Problem Type Value Set
FamilyHistory[].Problems[].Type.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
FamilyHistory[].Problems[].Type.NameString
ReliableName of the general class of the problem. (disease, problem, etc.)
FamilyHistory[].Problems[].DateTimeString
ProbableThe time when the problem started.
ISO 8601 Format
FamilyHistory[].Problems[].AgeAtOnsetString
ProbableThe relative's age when the problem started
FamilyHistory[].Problems[].IsCauseOfDeathBoolean
ProbableFlag indicating whether or not this problem was the cause of death for the relative.
HistoryOfPresentIllness
HistoryOfPresentIllnessTextString
ProbableFree text describing the history related to the reason for the encounter.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Immunizations
ImmunizationTextString
ProbableFree text form of the immunization summary
Immunizations[]Array of Objects
ReliableArray of immunizations for patient.
Immunizations[].DateTimeString
ReliableRequiredWhen the immunization was given.
ISO 8601 Format
Immunizations[].Route.CodeString
ProbableA code describing the way in which the immunization was delivered (intramuscular, oral, etc.).
Medication Route FDA Value Set
Immunizations[].Route.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Route.NameString
ProbableName of the way in which the immunization was delivered (intramuscular, oral, etc.)
Immunizations[].Product.ManufacturerString
ProbableName of organization that manufacture the immunization.
Free text
Immunizations[].Product.CodeString
ReliableRequiredA code describing the vaccination that was given.
CVX code system
Immunizations[].Product.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Immunizations[].Product.NameString
ReliableName of the vaccination that was given
Immunizations[].Product.LotNumberString
ProbableThe lot number of the vaccine
Immunizations[].Dose.QuantityString
ProbableThe size of the dose
Immunizations[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
Instructions
InstructionsTextString
ReliableRequiredFree text patient education and/or instructions.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Insurances
InsurancesTextString
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.IDString
ProbableIdentifier of insurance plan
Insurances[].Plan.IDTypeString
ProbableID type of insurance plan
Insurances[].Plan.NameString
ProbableName of insurance plan
Insurances[].Plan.TypeString
PossibleType of insurance plan
Insurances[].MemberNumberString
PossiblePatient member number
Insurances[].Company.IDString
PossibleID of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.IDTypeString
PossibleID type of insurance company (payor).
Typically not available in ClinicalSummary.
Insurances[].Company.NameString
ProbableName of insurance company (payor)
Insurances[].Company.AddressObject
ProbableInsurance company's address
Insurances[].Company.Address.StreetAddressString
ProbableStreet address
Insurances[].Company.Address.CityString
ProbableCity
Insurances[].Company.Address.StateString
ProbableState
Insurances[].Company.Address.ZIPString
ProbableZIP
Insurances[].Company.Address.CountyString
PossibleCounty
Insurances[].Company.Address.CountryString
PossibleCountry
Insurances[].Company.PhoneNumberString
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Insurances[].GroupNumberString
ProbableInsurance policy group number
Insurances[].GroupNameString
PossibleInsurance policy group name.
Typically not available in ClinicalSummary.
Insurances[].EffectiveDateString
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Insurances[].ExpirationDateString
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Insurances[].PolicyNumberString
ProbableInsurance policy number
Insurances[].AgreementTypeString
PossibleType of insurance agreement.
Typically not available in ClinicalSummary.
Insurances[].CoverageTypeString
ProbableType of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Insurances[].InsuredObject
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[].IDString
PossibleID for the insured
Insurances[].Insured.Identifiers[].IDTypeString
PossibleType of ID.
E.g. MRN, EPI
Insurances[].Insured.LastNameString
PossibleLast name of the insured
Insurances[].Insured.MiddleNameString
PossibleMiddle name of the insured
Insurances[].Insured.FirstNameString
PossibleFirst name of the insured
Insurances[].Insured.SSNString
PossibleInsured's social security number
Insurances[].Insured.RelationshipString
PossibleRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.DOBString
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Insurances[].Insured.SexString
PossibleSex of the insured
-
Additional values may be added by Redox in the future.
-
Insurances[].Insured.AddressObject
ProbableAddress of the insured
Insurances[].Insured.Address.StreetAddressString
ProbableStreet address
Insurances[].Insured.Address.CityString
ProbableCity
Insurances[].Insured.Address.StateString
ProbableState
Insurances[].Insured.Address.ZIPString
ProbableZIP
Insurances[].Insured.Address.CountyString
PossibleCounty
Insurances[].Insured.Address.CountryString
PossibleCountry
Interventions
InterventionsTextString
ReliableRequiredFree text about interventions given (procedural, education, application of assistive equipment, etc.).
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
MedicalEquipment
MedicalEquipmentTextString
ProbableFree text form of the medical equipment summary
MedicalEquipment[]String
ProbableA list of medical equipment that the patient uses (cane, pacemakers, etc.)
MedicalEquipment[].StatusString
ReliableRequiredThe current status of the equipment (active, completed, etc.)
MedicalEquipment[].StartDateString
ProbableWhen the equipment was first put into use.
ISO 8601 Format
MedicalEquipment[].QuantityString
ProbableThe number of products used
MedicalEquipment[].Product.CodeString
ProbableA code describing the actual product.
SNOMED CT
MedicalEquipment[].Product.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicalEquipment[].Product.NameString
ProbableName of the actual product.
Medications
MedicationsTextString
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[].PrescriptionBoolean
ReliableRequiredWhether the medication is a prescription.
For a prescription: true. For a patient reported med, or a med administered by a provider: false
Medications[].FreeTextSigString
PossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
Medications[].Dose.QuantityString
ProbableThe size of the dose for pills, capsules, etc.
Medications[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
Medications[].Rate.QuantityString
ProbableIf the medication is in liquid form, the rate at which it is administered
Medications[].Rate.UnitsString
ProbableUnits for the rate.
UCUM Units of Measure
Medications[].Route.CodeString
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
Medications[].Route.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Route.NameString
ProbableName of the method by which the medication is delivered
Medications[].StartDateString
ReliableRequiredWhen the medication was started.
ISO 8601 Format
Medications[].EndDateString
ProbableWhen the medication ended.
ISO 8601 Format
Medications[].Frequency.PeriodString
ProbableHow often the patient should be taking the medication.
UCUM Units of Measure
Medications[].Frequency.UnitString
ProbableUnits for how often the patient should be taking the medication
Medications[].IsPRNBoolean
ProbableWhether the medication is to be taken on an as-needed basis
Medications[].Product.CodeString
ReliableRequiredA code describing the actual medication given .
RxNorm
Medications[].Product.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Medications[].Product.NameString
ReliableName of the actual medication given
MedicationsAdministered
MedicationsAdministeredTextString
ReliableFree text form of the administered medications summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
MedicationsAdministered[]Array of Objects
Probable
MedicationsAdministered[].Dose.QuantityString
ProbableThe size of the dose for pills, capsules, etc.
MedicationsAdministered[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
MedicationsAdministered[].Rate.QuantityString
ProbableIf the medication is in liquid form, the rate at which it is administered
MedicationsAdministered[].Rate.UnitsString
ProbableUnits for the rate.
UCUM Units of Measure
MedicationsAdministered[].Route.CodeString
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
MedicationsAdministered[].Route.CodeSystemString
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.
MedicationsAdministered[].Route.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicationsAdministered[].Route.NameString
ProbableName of the method by which the medication is delivered
MedicationsAdministered[].StartDateString
ReliableRequiredWhen the medication was started.
ISO 8601 Format
MedicationsAdministered[].EndDateString
ProbableWhen the medication ended or is intended to end. If the medication is a single-administration, this may be identical to the start date.
ISO 8601 Format
MedicationsAdministered[].Frequency.PeriodString
ProbableHow often the patient should be taking the medication.
UCUM Units of Measure
MedicationsAdministered[].Frequency.UnitString
ProbableUnits for how often the patient should be taking the medication
MedicationsAdministered[].Product.CodeString
ReliableRequiredA code describing the actual medication given .
RxNorm
MedicationsAdministered[].Product.CodeSystemString
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.
MedicationsAdministered[].Product.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
MedicationsAdministered[].Product.NameString
ReliableName of the actual medication given
Objective
ObjectiveTextString
ReliableRequiredFree text pertaining to data that can be quantified or categorized.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
PhysicalExam
PhysicalExamTextString
ReliableRequiredFree text regarding the physical exam, observations by clinician.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
PlanOfCare
PlanOfCareTextString
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[].CodeString
ProbableA code describing the test to be performed .
LOINC
PlanOfCare.Orders[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Orders[].NameString
ProbableName of the test to be performed
PlanOfCare.Orders[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Orders[].DateTimeISO Format
Probable
PlanOfCare.Procedures[]Array of Objects
ProbableFuture procedures.
PlanOfCare.Procedures[].CodeString
ProbableA code describing the planned procedure, such as an appendectomy or hip replacement .
SNOMED CT
PlanOfCare.Procedures[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Procedures[].NameString
ProbableName of the planned procedure, such as an appendectomy or hip replacement
PlanOfCare.Procedures[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Procedures[].DateTimeISO Format
Probable
PlanOfCare.Encounters[]Array of Objects
ProbableAppointments and other upcoming encounters
PlanOfCare.Encounters[].CodeString
ProbableA code describing the planned encounter type .
SNOMED CT
PlanOfCare.Encounters[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Encounters[].NameString
ProbableName of the planned encounter type
PlanOfCare.Encounters[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Encounters[].DateTimeString
Probable
PlanOfCare.MedicationAdministration[]Array of Objects
ProbablePlanned medication
PlanOfCare.MedicationAdministration[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.MedicationAdministration[].Dose.QuantityString
ProbableThe size of the dose for pills, capsules, etc.
PlanOfCare.MedicationAdministration[].Dose.UnitsString
ProbableThe units of the dose.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Rate.QuantityString
ProbableIf the medication is not in does form, this is the rate at which is administered
PlanOfCare.MedicationAdministration[].Rate.UnitsString
ProbableUnits for the rate.
UCUM Units of Measure
PlanOfCare.MedicationAdministration[].Route.CodeString
ProbableA code describing the method by which the medication is to be delivered.
Medication Route FDA Value Set
PlanOfCare.MedicationAdministration[].Route.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Route.NameString
ProbableName of the method by which the medication is to be delivered
PlanOfCare.MedicationAdministration[].StartDateISO Format
ProbableWhen the medication was started
PlanOfCare.MedicationAdministration[].EndDateISO Format
ProbableWhen the medication ended
PlanOfCare.MedicationAdministration[].Frequency.PeriodString
ProbableHow often the patient should be taking the medication.
UCUM Units of measure
PlanOfCare.MedicationAdministration[].Frequency.UnitString
ProbableUnits for how often the patient should be taking the medication
PlanOfCare.MedicationAdministration[].Product.CodeString
ProbableA code describing the planned medication .
RxNorm
PlanOfCare.MedicationAdministration[].Product.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.MedicationAdministration[].Product.NameString
ProbableName of the planned medication
PlanOfCare.Supplies[]Array of Objects
ProbableFuture supplies that a patient may be given, including implants.
PlanOfCare.Supplies[].CodeString
ProbableA code describing the planned product.
SNOMED CT
PlanOfCare.Supplies[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Supplies[].NameString
ProbableName of the planned product
PlanOfCare.Supplies[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Supplies[].DateTimeISO 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[].CodeString
ProbableA code describing the planned activity.
SNOMED CT
PlanOfCare.Services[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
PlanOfCare.Services[].NameString
ProbableName of the planned activity.
PlanOfCare.Services[].StatusString
ProbableThe state of the plan (intent, confirmed, etc).
Plan of care status
PlanOfCare.Services[].DateTimeISO Format
ProbableThe scheduled time of the activity. .
ISO 8601 Format
Problems
ProblemsTextString
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[].StartDateString
ProbableWhen the problem was noticed.
ISO 8601 Format
Problems[].EndDateString
ProbableWhen the problem stopped (if it is not current).
ISO 8601 Format
Problems[].CodeString
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[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].NameString
ReliableName of the actual problem
Problems[].Category.CodeString
ReliableRequiredA code describing the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].Category.CodeSystemString
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.CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Category.NameString
ReliableName of the type of problem this is (complaint, diagnosis, symptom, etc.)
Problems[].HealthStatus.CodeString
ProbableA code describing the effect of the problem on the patient (chronically ill, in remission, etc.).
SNOMED-CT
Problems[].HealthStatus.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].HealthStatus.NameString
ProbableName of the effect of the problem on the patient (chronically ill, in remission, etc.)
Problems[].Status.CodeString
ProbableA code describing the current state of the problem (active, inactive, resolved).
HITSPProblemStatus
Problems[].Status.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Problems[].Status.NameString
ProbableName of the current state of the problem (active, inactive, resolved)
Procedures
ProceduresTextString
ProbableFree text form of the procedures summary
ProceduresProbableA 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[].CodeString
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Observations[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].NameString
ProbableName of the procedure that was performed.
Procedures.Observations[].DateTimeProbableWhen the procedure was performed.
Procedures.Observations[].StatusProbableThe status of the procedure.
Procedures.Observations[].TargetSite.CodeString
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Observations[].TargetSite.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Observations[].TargetSite.NameString
ProbableName 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[].CodeString
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Procedures[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].NameString
ProbableName of the procedure that was performed.
Procedures.Procedures[].DateTimeProbableWhen the procedure was performed.
Procedures.Procedures[].StatusProbableThe status of the procedure.
Procedures.Procedures[].TargetSite.CodeString
ProbableA code describing the location on the body where the procedure was performed.
SNOMED CT
Procedures.Procedures[].TargetSite.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Procedures[].TargetSite.NameString
ProbableName 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[].CodeString
ProbableA code describing the procedure that was performed. .
SNOMED CT
Procedures.Services[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Procedures.Services[].NameString
ProbableName of the procedure that was performed.
Procedures.Services[].DateTimeProbableWhen the procedure was performed.
Procedures.Services[].StatusProbableThe status of the procedure.
ReasonForReferral
ReasonForReferralTextString
ProbableFree text recording the reason the patient is being referred for a consultation by a provider.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
ReasonForVisit
ReasonForVisitTextString
ProbableFree text describing the patient's reason for the patient's visit.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
Results
ResultTextString
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[].CodeString
ReliableRequiredA code describing the test performed and resulted.
LOINC for Lab, SNOMED CT otherwise
Results[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].NameString
ReliableName of the test performed and resulted.
Results[].StatusString
ReliableRequiredThe status of the test (In Progress, Final)
Results[].Observations[]Array of Object
ReliableA list of corresponding observations for the test (result components)
Results[].Observations[].CodeString
ReliableRequiredA code describing the individual result component. .
LOINC for Lab, SNOMED CT otherwise
Results[].Observations[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].NameString
ReliableName of the individual result component.
Results[].Observations[].StatusString
ReliableRequiredThe status of the individual component. Some tests may have different components finish at different times. .
One of (In Progress, Final)
Results[].Observations[].InterpretationString
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
Results[].Observations[].DateTimeString
ReliableRequiredA specific date/time when the value was recorded.
ISO 8601 Format
Results[].Observations[].CodedValue.CodeString
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.CodeSystemString
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.CodeSystemNameString
PossibleCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Results[].Observations[].CodedValue.NameString
PossibleName of the individual result value.
Results[].Observations[].ValueString
ReliableRequiredThe measurement recorded for the result.
Results[].Observations[].ValueTypeString
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[].UnitsString
ReliableRequiredThe units of the measurement.
Only available when ValueType is PhysicalQuantity
Results[].Observations[].ReferenceRangeObject
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.LowNumeric
PossibleLower bound for a normal result
Results[].Observations[].ReferenceRange.HighNumeric
PossibleUpper bound for a normal result
Results[].Observations[].ReferenceRange.TextString
PossibleThe normal value for non-numeric results
ReviewOfSystems
ReviewOfSystemsTextString
ReliableRequiredFree text about symptoms and wellbeing of the patient.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
SocialHistory
SocialHistoryTextString
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[].CodeString
ProbableA code describing a type of social history observation (exercise, alcohol intake, etc.) .
SNOMED CT
SocialHistory.Observations[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].NameString
ProbableName of a type of social history observation (exercise, alcohol intake, etc.)
SocialHistory.Observations[].ValueObject
ProbableThe observed value
SocialHistory.Observations[].Value.CodeString
ProbableA code describing the observed value, if coded
SocialHistory.Observations[].Value.CodeSystemString
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.CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.Observations[].Value.NameString
ProbableName of the observed value, if coded
SocialHistory.Observations[].ValueTextString
ProbableThe observed value, if uncoded
SocialHistory.Observations[].StartDateString
ProbableStart date of status
SocialHistory.Observations[].EndDateString
ProbableDate status ended. If this is null, the status is current.
SocialHistory.Pregnancy[]String
ProbableInformation about past and current pregnancies.
SocialHistory.Pregnancy[].StartDateString
ProbableWhen the pregnancy started.
ISO 8601 Format
SocialHistory.Pregnancy[].EndDateString
ProbableWhen the pregnancy ended.
ISO 8601 Format
SocialHistory.Pregnancy[].EstimatedDeliveryString
ProbableEstimate delivery date if pregnancy is still active.
SocialHistory.TobaccoUse[]String
ProbableContains tobacco use and smoking status observations
SocialHistory.TobaccoUse[].CodeString
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[].CodeSystemString
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[].CodeSystemNameString
ProbableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
SocialHistory.TobaccoUse[].NameString
ProbableName of the use of tobacco (current smoker, never smoker, snuff user, etc.)
SocialHistory.TobaccoUse[].IsSmokingStatusBoolean
ProbableIdentifies this tobacco use entry as a smoking status.
If true, StartDate is the date the smoking status was observed.
SocialHistory.TobaccoUse[].StartDateString
ProbableStart date of status.
If IsSmokingStatus is true, this is the date the observation was made.
SocialHistory.TobaccoUse[].EndDateString
ProbableDate status ended. If this is null, the status is current.
Subjective
SubjectiveTextString
ReliableRequiredFree text description of the patient's condition as reported by the patient and documented by the clinician.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.
VitalSigns
VitalSignsTextString
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[].DateTimeString
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[].CodeString
ReliableRequiredA code describing the type of vital sign being read (height, weight, blood pressure, etc.).
LOINC (HITSP Vital Sign Result Type).
VitalSigns[].Observations[].CodeSystemString
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[].CodeSystemNameString
ReliableCoding system to which the code belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
VitalSigns[].Observations[].NameString
ReliableName of the type of vital sign being read (height, weight, blood pressure, etc.)
VitalSigns[].Observations[].StatusString
ReliableRequiredThe status of the reading (usually completed)
VitalSigns[].Observations[].InterpretationString
ProbableA flag indicating whether or not the observed value is normal, high, or low.
Supported Values
VitalSigns[].Observations[].DateTimeString
ReliableRequiredThe date/time when the specific vital sign was recorded.
ISO 8601 Format
VitalSigns[].Observations[].ValueString
ReliableRequiredThe measurement recorded for the vital sign.
VitalSigns[].Observations[].UnitsString
ReliableRequiredThe units of the measurement.
UCUM Units of Measure
{
"Meta": {
"DataModel": "Clinical Summary",
"EventType": "VisitQueryResponse",
"EventDateTime": "2019-10-24T23:54:41.339Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "ef9e7448-7f65-4432-aa96-059647e9b358",
"Name": "Visit 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",
"Visit": {
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"Room": "136"
},
"StartDateTime": "2019-10-24T23:54:41.796Z",
"EndDateTime": "2019-10-24T23:54:41.796Z",
"Reason": "Annual Physical",
"VisitNumber": "30311442"
}
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR",
"Type": null
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID",
"Type": null
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST",
"Type": null
}
],
"Demographics": {
"FirstName": "Timothy",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"County": "Green",
"Country": "US",
"ZIP": "53566"
},
"PhoneNumber": {
"Home": "+18088675301",
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Race": "White",
"Ethnicity": null,
"Religion": null,
"MaritalStatus": "Married"
}
}
},
"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"
},
"Code": "304253006",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Do not resuscitate",
"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"
},
"Substance": {
"Code": "7982",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Penicillin G benzathine"
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Rash",
"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",
"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"
},
"Substance": {
"Code": "2670",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Codeine"
},
"Reaction": [
{
"Code": "267036007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Shortness of Breath",
"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"
},
"Substance": {
"Code": "1191",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Aspirin"
},
"Reaction": [
{
"Code": "247472004",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Hives",
"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
}
],
"AssessmentText": "<list><item>Recurrent GI bleed of unknown etiology; hypotension perhaps secondary to this but as likely secondary to polypharmacy.</item><item>Acute on chronic anemia secondary to #1.</item><item>Azotemia, acute renal failure with volume loss secondary to #1.</item><item>Hyperkalemia secondary to #3 and on ACE and K+ supplement.</item><item>Other chronic diagnoses as noted above, currently stable.</item></list>Also, this person has back problems.",
"Assessment": {
"Diagnoses": [
{
"Value": "Displacement of lumbar intervertebral disc without myelopathy",
"DateTime": "2009-11-01T05:00:00.000Z",
"IsNegativeIndicator": false,
"Codes": []
},
{
"Value": "Thoracic or lumbosacral neuritis or radiculitis, unspecified",
"DateTime": "2009-11-01T05:00:00.000Z",
"IsNegativeIndicator": false,
"Codes": []
}
]
},
"ChiefComplaintText": "<paragraph>Dark stools.</paragraph>",
"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>Pnuemonia</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"
},
"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"
}
}
],
"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"
},
"Name": "Community Health and Hospitals"
}
],
"Diagnosis": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia"
}
],
"ReasonForVisit": [
{
"Code": "233604007",
"CodeSystem": "2.16.840.1.113883.6.96",
"CodeSystemName": "SNOMED CT",
"Name": "Pneumonia"
}
]
}
],
"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",
"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",
"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
}
]
}
],
"HistoryOfPresentIllnessText": "<list><item><caption>Kelp, Lonnie Ray Sr., MD PHD - 10/21/2014 8:07 PM PST</caption><paragraph>Date: 10/21/2014<br/><br/>Pre-procedure diagnosis: L5 S1 Acute Lumbar Radiculopathy (Right)<br/><br/>Post-procedure diagnosis: Same<br/><br/>Procedure: 1) L5S1 Transforaminal Epidural Steroid injection(Right)<br/>2) Fluoroscopic Guidance for needle placement<br/><br/>Complications: None<br/><br/>CONSENT: Today's procedure, its potential benefits as well as its risks and potential side effects were reviewed. Discussed risks of the procedure include bleeding, infection, nerve irritation or damage, reactions to the medications, headache, failure of the pain to improve, and exacerbation of the pain were explained to the patient, who verbalized understanding and who wished to proceed. Informed consent was signed.<br/><br/>DESCRIPTION OF PROCEDURES: After written informed consent was obtained, the patient was taken to the fluoroscopy suite. Anatomical landmarks were identified by way of fluoroscopy in multiple views. Strict aseptic technique was utilized.<br/><br/>A 22-gauge 3-1/2-inch needle was then incrementally advanced using multiple fluoroscopic views from an oblique approach into the Right L5S1 lumbar intervertebral space. Both AP and lateral views were used to confirm final needle placement. After negative aspiration, Omniopaque 240 contrast was injected which delineated epidural without vascular flow and a normal epidurogram under fluoroscopy in the lateral and AP view. After negative aspiration was reconfirmed, a 1.0 mL of 0.25% Bupivicaine and 1mL of 40 mg/mL of Kenalog was slowly injected into the epidural space.<br/><br/>All needles were removed intact. Hemostasis was maintained. There were no complications. The area was cleaned and a Band-Aid placed as necessary. The patient tolerated the procedure well and all needles were removed intact. After a period of observation, the patient was noted to be hemodynamically stable and neurovascularly intact following the procedure as prior to the procedure, and was ultimately discharged to home with supervision in good condition. The patient was instructed to schedule an appointment in the office within 2 weeks.<br/>Lonnie Ray Kelp Sr., MD PHD<br/><br/></paragraph></item></list>",
"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"
},
"Product": {
"Manufacturer": "Health LS - Immuno Inc.",
"Code": "88",
"CodeSystem": "2.16.840.1.113883.6.59",
"CodeSystemName": "CVX",
"Name": "Influenza virus vaccine",
"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"
},
"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",
"LotNumber": null
},
"Dose": {
"Quantity": "50",
"Units": "mcg"
}
}
],
"InstructionsText": "Please carefully follow the subsequent instructions and patient education:<br/><br/><list><item>Floss</item><item>Brush teeth twice daily</item></list><br/><br/>Scarf tying instructions may be found online.",
"InsurancesText": null,
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductable 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
}
}
}
],
"InterventionsText": "Patient practiced use of novel prosthesis including movements formerly neglected including distal extension and retroflexive hyperextension.",
"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"
}
},
{
"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"
}
},
{
"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"
}
}
],
"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"
},
"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"
}
},
{
"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)"
},
"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"
}
}
],
"MedicationsAdministeredText": "<table width=\"100%\"><thead><tr><th>Medication</th><th>Start Date</th><th>Status</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></tr></tbody></table>",
"MedicationsAdministered": [
{
"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"
},
"StartDate": "2013-11-11T05:00:00.000Z",
"EndDate": null,
"Frequency": {
"Period": "8",
"Unit": "h"
},
"Product": {
"Code": "104894",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Ondansetron 4 Mg Po Tbdp"
}
},
{
"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)"
},
"StartDate": "2012-08-06T04:00:00.000Z",
"EndDate": "2012-08-13T04:00:00.000Z",
"Frequency": {
"Period": "12",
"Unit": "h"
},
"Product": {
"Code": "573621",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Albuterol 0.09 MG/ACTUAT inhalant solution"
}
}
],
"ObjectiveText": "<list><item>Chest: clear to ausc. No rales, normal breath sounds</item><item>Heart: RR, PMI in normal location and no heave or evidence ofcardiomegaly,normal heart sounds, no murm or gallop</item></list>",
"PhysicalExamText": "All examinations performed within normal limits.<br/><br/>WNL<br/><br/>Nothing to report here.",
"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",
"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",
"Status": "Request",