This data model provides a snapshot of the patient's chart at a moment in time.
A clinical summary is useful if you need a patient's clinical information, whether historical or current. Our data model is based on Clinical Document Architecture (CDA) formatted documents, which focuses on different aspects of the patient's chart (e.g., allergies, immunizations, medications). We map any CDA document type to this data model. The most common is the Continuity of Care Document (CCD).
It may take up to 15 seconds to receive a response from the EHR system when querying for a clinical summary, depending on how long it takes the EHR system to generate a CCD.
This data model has event types that allow you to:
- query for patient, visit, and document summaries;
- receive patient, visit, and document summaries;
- push patient or visit summaries; or
- query for and receive a specific document.
Receive the most recent visit summary based on the query parameters defined in VisitQuery. 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
Request Body Schema
- Metarequired, object- DataModelrequired, stringReliableClinical Summary 
- EventTyperequired, stringReliableVisitQueryResponse 
- EventDateTimestring, nullReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received. 
 ISO 8601 Format
- Testboolean, nullReliableIndicates whether the request is a test or not. 
- SourceobjectContains the information for the system initiating the message, including the source ID and name. 
 Included in messages from Redox- IDstring, nullReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional. 
 UUID
- Namestring, nullReliableDisplays the name of the system initiating the message. 
 
- DestinationsArray of objectContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination. 
 Required when sending data to Redox.- IDstring, nullReliableIdentifies the endpoint that the request is directed to. 
 UUID
- Namestring, nullReliableDisplays the name of the endpoint that the request is directed to. 
 
- LogsArray of objectContains the log identifier(s) for the request. - IDstring, nullReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference. 
 UUID
- AttemptIDstring, nullReliableIdentifies the request log attempt value, which is useful when retries are possible. 
 UUID
 
- FacilityCodestring, nullPossibleCode for the facility related to the message. 
 Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
 
- Headerobject- DocumentobjectAn object containing metadata about the document being pushed to the destination. - Authorobject- IDstring, nullReliableID of the Provider responsible for the document. 
 This ID is often required for Inpatient Visits.
- IDTypestring, nullReliableID type of the ID for the Provider responsible for the document 
- FirstNamestring, nullPossibleFirst name of the Provider responsible for the document 
- LastNamestring, nullPossibleLast name of the Provider responsible for the document 
- CredentialsArray of stringList of credentials for the Provider responsible for the document. 
 e.g. MD, PhD
- AddressobjectProvider's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- EmailAddressesArray of stringProvider's email address(es) 
- PhoneNumberobject- Officestring, nullPossibleProvider's office phone number. 
 In E. 164 Format. (e.g. +16085551234)
 
- Typestring, nullReliableValue SetThe type of Provider responsible for the document 
- LocationobjectProvider's location - Typestring, nullPossibleType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullPossibleFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullPossibleAn ID specific to this facility 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullPossibleDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullPossibleAn ID specific to this department 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullPossibleRoom. 
 Example: 136
 
 
- IDstring, nullReliableYour application's ID for the document 
- SetIDstring, nullPossibleAn ID for the document that is common across all document revisions. 
 WhenSetIDis provided,VersionNumberis required.
- VersionNumberstring, nullPossibleAn integer version number for this revision of the document. 
 WhenSetIDis provided,VersionNumberis required. Used when superseding or modifying a prior version of the same document. For example, this document might beVersionNumber2, and it has aRelatesTo[].VersionNumber1, the prior version with the sameRelatesTo[].SetID.
- RelatesToArray of objectThe identifiers for other documents related to this document, such as prior versions that this document replaces. - Codestring, nullReliableA code for how the related document interacts with this document. 
 FHIR Document Relationship Type or CDA RelatedDocument TypeCode:APND(appends),RPLC(replaces), orXFRM(transforms).
- IDstring, nullReliableThe ID of the related document 
- SetIDstring, nullPossibleAn ID for the document that is common across all document revisions. 
 WhenSetIDis provided,VersionNumberis required.
- VersionNumberstring, nullPossibleAn integer version number for the related revision of the document. 
 WhenSetIDis provided,VersionNumberis required.
 
- Localestring, nullReliableThe language of the document. 
- Titlestring, nullReliableThe title of the document. 
- DateTimestring, nullReliableThe creation/publishing date/time of the document. 
- Typestring, nullReliableThe type of document. 
 This field is slated to be deprecated in favor of Header.Document.TypeCode.Name
- TypeCodeobject- Codestring, nullReliableA code describing the type of document. 
 LOINC Document Type
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (LOINC preferred). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the type of document. 
 Summarization of Episode Note, Progress Note, etc.
 
- Confidentialityobject- Codestring, nullReliableA code describing intended disclosure of information contained within the document. 
 N (Normal), R (Restricted), V (Very Restricted)
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of intended disclosure of information contained within the document 
 
- CustodianobjectThe organization or group responsible for the ongoing maintenance and access to the document - IdentifiersArray of objectList of IDs specific to this custodian organization - IDstring, nullProbableAn ID specific to this custodian organization 
- IDTypestring, nullProbableThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Namenull, nullProbableThe name of the custodian organization 
- Typeobject- Codestring, nullProbableA code describing the kind of custodian organization 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the kind of custodian organization 
- AltCodesArray of objectAlternate or translation codes for the kind of custodian organization - Codestring, nullPossibleA code describing the kind of custodian organization 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the kind of custodian organization 
 
 
- AddressobjectThe address information for the custodian organization - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
- Usestring, nullProbableUse 
 
- TelecomArray of objectPhone, fax, email, or other communication numbers for the custodian organization - Valuenull, nullProbableThe phone number or telecommunications address 
- Usenull, nullProbableThe purpose of this telecommunications address (e.g. home, work, direct) 
- Systemnull, nullProbableThe form of this address (e.g. phone, email, fax). 
 Supported Values
 
 
- VisitobjectIf the document is tied to a visit, this contains information about the encompassing encounter. - StartDateTimestring, nullProbableThe start date/time of the visit. 
 ISO 8601 Format
- EndDateTimestring, nullProbableThe end date/time of the visit. 
 ISO 8601 Format
- Reasonstring, nullPossibleThe reason for visit. 
 The Reason for Visit is rarely found in the header. Instead, look to the ReasonForVisitText and related fields.
- VisitNumberstring, nullReliableID for the patient visit/encounter. 
- Typeobject- Codestring, nullProbableA code describing the type of visit (office visit, hospital, etc). 
 CPT-4
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the type of visit (office visit, hospital, etc) 
- AltCodesArray of objectAlternate or translation codes for the type of visit (office visit, hospital, etc) - Codestring, nullPossibleA code describing the type of visit (office visit, hospital, etc) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of visit (office visit, hospital, etc) 
 
 
- LocationobjectThe location of the visit. Note - more precise information may be available via an extension. - Typestring, nullPossibleType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullPossibleFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullPossibleAn ID specific to this facility 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullPossibleDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullPossibleAn ID specific to this department 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullPossibleRoom. 
 Example: 136
 
- DischargeDispositionobject- Codestring, nullProbableA code describing the discharge disposition of the visit. 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the discharge disposition of the visit. 
- AltCodesArray of objectAlternate or translation codes for the discharge disposition of the visit. - Codestring, nullPossibleA code describing the discharge disposition of the visit. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the discharge disposition of the visit. 
 
 
 
 
- Patientobject- IdentifiersArray of objectAn array of identifiers for the patient. - IDstring, nullReliableThe actual identifier for the patient. 
- IDTypestring, nullReliableAn ID type associated with identifier (Medical Record Number, etc.) 
- Typestring, nullReliableIf present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API. 
 
- Demographicsobject- FirstNamestring, nullReliablePatient's first name 
- MiddleNamestring, nullProbablePatient's middle name 
- LastNamestring, nullReliablePatient's last name 
- DOBstring, nullReliablePatient's date of birth. 
 In YYYY-MM-DD format
- SSNstring, nullReliablePatient SSN 
- Sexstring, nullReliableValue SetPatient gender 
- Addressobject- StreetAddressstring, nullReliable
- Citystring, nullReliable
- Statestring, nullReliable
- Countystring, nullReliable
- Countrystring, nullReliable
- ZIPstring, nullReliable
- Usestring, nullPossible
 
- PhoneNumberobject- Homestring, nullReliable
- Mobilestring, nullReliable
 
- EmailAddressesArray of object- Addressstring, nullReliable
 
- Languagestring, nullPossiblePatient's primary spoken language. 
 In ISO 639-1 alpha values (e.g. 'en'). Supported Values
- Racestring, nullReliableValue SetPatient's race - this is equivalent to the first RaceCodes[].Name 
- RaceCodesArray of object- Codestring, nullProbableA code describing the patient's race 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the patient's race 
 
- Ethnicitystring, nullReliableOne of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown 
- EthnicGroupCodesArray of object- Codestring, nullProbableA code describing the patient's ethnicity 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the patient's ethnicity 
 
- Religionstring, nullReliableValue SetPatient's religious affiliation 
- MaritalStatusstring, nullReliableValue Set
- IsDeceasedboolean, nullPossibleIndicates if the patient is deceased 
- DeathDateTimestring, nullPossibleDate and Time the patient was proclaimed deceased. 
 ISO 8601 Format
 
- OrganizationobjectOrganization that is the custodian of the patient record - IdentifiersArray of objectList of IDs specific to this organization - IDstring, nullProbableAn ID specific to this organization 
- IDTypestring, nullProbableThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Namenull, nullProbableThe name of the organization 
- Typeobject- Codestring, nullProbableA code describing the kind of organization 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the kind of organization 
- AltCodesArray of objectAlternate or translation codes for the kind of organization - Codestring, nullPossibleA code describing the kind of organization 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the kind of organization 
 
 
- AddressobjectThe address information for the organization - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
- Usestring, nullProbableUse 
 
- TelecomArray of objectPhone, fax, email, or other communication numbers for the organization - Valuenull, nullProbableThe phone number or telecommunications address 
- Usenull, nullProbableThe purpose of this telecommunications address (e.g. home, work, direct) 
- Systemnull, nullProbableThe form of this address (e.g. phone, email, fax). 
 Supported Values
 
 
 
- PCPobject- IDstring, nullPossibleID of the Primary Care Provider for the Patient. 
 This ID is often required for Inpatient Visits.
- IDTypestring, nullPossibleID type of the ID for the Primary Care Provider for the Patient 
- FirstNamestring, nullPossibleFirst name of the Primary Care Provider for the Patient 
- LastNamestring, nullPossibleLast name of the Primary Care Provider for the Patient 
- CredentialsArray of stringList of credentials for the Primary Care Provider for the Patient. 
 e.g. MD, PhD
- AddressobjectProvider's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- EmailAddressesArray of stringProvider's email address(es) 
- PhoneNumberobject- Officestring, nullPossibleProvider's office phone number. 
 In E. 164 Format. (e.g. +16085551234)
 
- Typestring, nullPossibleValue SetThe type of Primary Care Provider for the Patient 
- LocationobjectProvider's location - Typestring, nullPossibleType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullPossibleFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullPossibleAn ID specific to this facility 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullPossibleDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullPossibleAn ID specific to this department 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullPossibleRoom. 
 Example: 136
 
 
 
- AdmissionDiagnosisTextstring, nullPossibleFree text of the clinician's conclusions at time of Admission. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- AdmissionDiagnosisArray of objectAn array of diagnoses - StartDatestring, nullPossibleThe onset date of the diagnosis. 
 ISO 8601 Format
- EndDatestring, nullPossibleThe resolution date of the diagnosis. 
 ISO 8601 Format
- Statusobject- Codestring, nullPossibleA code describing the current state of the diagnosis (active, inactive, resolved). 
 HITSPProblemStatus
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the current state of the diagnosis (active, inactive, resolved) 
 
- IsNegativeIndicatorboolean, nullPossibleAbsent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true 
- Codestring, nullPossibleA code describing the diagnosis. 
 ICD9, ICD10, HCPC, CPT, SNOMED CT
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the diagnosis 
- AltCodesArray of objectAlternate or translation codes for the diagnosis - Codestring, nullPossibleA code describing the diagnosis 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the diagnosis 
 
- CommentsArray of objectFree text comments about the diagnosis. - Textstring, nullReliableThe plain text comment. 
 
 
- AdvanceDirectivesTextstring, nullProbableFree text form of the advance directives summary 
- AdvanceDirectivesArray of object- Typeobject- Codestring, nullReliableA code describing the type of advance directive (such as resuscitation). 
 SNOMED CT
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the type of advance directive (such as resuscitation) 
- AltCodesArray of objectAlternate or translation codes for the type of advance directive (such as resuscitation) - Codestring, nullPossibleA code describing the type of advance directive (such as resuscitation) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of advance directive (such as resuscitation) 
 
 
- Codestring, nullReliableA code describing the value of the advance directive (such as 'do not resuscitate'). 
 SNOMED CT
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the value of the advance directive (such as 'do not resuscitate') 
- AltCodesArray of objectAlternate or translation codes for the value of the advance directive (such as 'do not resuscitate') - Codestring, nullPossibleA code describing the value of the advance directive (such as 'do not resuscitate') 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the value of the advance directive (such as 'do not resuscitate') 
 
- StartDatestring, nullReliableEffective start date of the advance directive. 
 ISO 8601 Format
- EndDatestring, nullProbableEffective end date of the advance directive. 
 ISO 8601 Format
- ExternalReferencestring, nullProbableA link to a location where the document can be accessed. 
- VerifiedByArray of objectA collection of people who verified the advance directive with the patient - FirstNamestring, nullProbable
- LastNamestring, nullProbable
- Credentialsstring, nullProbable
- DateTimestring, nullProbable
 
- CustodiansArray of objectPeople legally responsible for the advance directive document. - FirstNamestring, nullProbable
- LastNamestring, nullProbable
- Credentialsstring, nullProbable
- Addressobject- StreetAddressstring, nullProbable
- Citystring, nullProbable
- Statestring, nullProbable
- Countrystring, nullProbable
- ZIPstring, nullProbable
 
 
 
- AllergyTextstring, nullReliableFree text form of the allergies summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- AllergiesArray of object- Typeobject- Codestring, nullReliableA code describing the type of allergy intolerance this is (food, drug, etc.). 
 SNOMED CT from Allergy/Adverse Event Type Value Set
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the type of allergy intolerance this is (food, drug, etc.) 
- AltCodesArray of objectAlternate or translation codes for the type of allergy intolerance this is (food, drug, etc.) - Codestring, nullPossibleA code describing the type of allergy intolerance this is (food, drug, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of allergy intolerance this is (food, drug, etc.) 
 
 
- Substanceobject- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the substance that the causes the allergy/intolerance 
- AltCodesArray of objectAlternate or translation codes for the substance that the causes the allergy/intolerance - Codestring, nullPossibleA code describing the substance that the causes the allergy/intolerance 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the substance that the causes the allergy/intolerance 
 
 
- ReactionArray of objectAll the reactions caused by this particular substance. 
 SNOMED CT- Codestring, nullReliableA code describing the reaction caused by the allergy (dizziness, hives ,etc.). 
 SNOMED CT
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the reaction caused by the allergy (dizziness, hives ,etc.) 
- AltCodesArray of objectAlternate or translation codes for the reaction caused by the allergy (dizziness, hives ,etc.) - Codestring, nullPossibleA code describing the reaction caused by the allergy (dizziness, hives ,etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the reaction caused by the allergy (dizziness, hives ,etc.) 
 
- Severityobject- Codestring, nullReliableA code describing a code for the severity of the reaction (moderate, severe, etc.). 
 SNOMED CT
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of a code for the severity of the reaction (moderate, severe, etc.) 
 
- Textstring, nullReliableFree text form of reactions to this substance, includes information that cannot be captured by coded value. 
 
- Severityobject- Codestring, nullPossibleA code describing a code for the severity of the reaction (moderate, severe, etc.). 
 SNOMED CT. Note that when multiple reactions have different severities, the severity at the allergy[] level is generally the highest of all reaction severities. This field is no longer recommended for use, but is preserved for backwards compatibility.
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of a code for the severity of the reaction (moderate, severe, etc.). 
 
- Criticalityobject- Codestring, nullPossibleA code describing a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.). 
 SNOMED CT. Note this is a different concept than reaction severity.
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.). 
 
- Statusobject- Codestring, nullReliableA code describing the current status of the allergy (active, historic, etc.). 
 SNOMED CT (Active, Inactive, Resolved)
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the current status of the allergy (active, historic, etc.) 
 
- IsNegativeIndicatorboolean, nullPossibleAbsent or false for a normal allergy/intolerance; indicates that the allergy/intolerance is explicitly unlikely when true 
- StartDatestring, nullProbableWhen the allergy was first noted. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen the allergy was no longer a problem (if applicable). 
 ISO 8601 Format
- Commentstring, nullPossibleFree text comment about the allergy. 
 This field is slated to be deprecated in favor of Comments[].Text
- CommentsArray of objectFree text comments about the allergy. - Textstring, nullReliableThe plain text comment. 
 
 
- AssessmentTextstring, nullProbableFree 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.
- Assessmentobject- DiagnosesArray of objectAn array of diagnoses - Valuestring, nullProbableThe diagnosis as free text 
- DateTimestring, nullProbableWhen the diagnosis was recorded. 
 ISO 8601 Format
- IsNegativeIndicatorboolean, nullProbableAbsent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true 
- CodesArray of object- Codestring, nullProbableA code describing the diagnosis. 
 ICD9, ICD10, HCPC, CPT, SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the diagnosis 
 
- CommentsArray of objectFree text comments about the diagnosis. - Textstring, nullReliableThe plain text comment. 
 
 
 
- CareTeamsTextstring, nullPossibleFree text summary of the patient's current and/or historical care teams. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- CareTeamsArray of object- Namestring, nullName of the care team 
- Statusstring, nullStatus of the care team 
- TypesArray of object- Codestring, nullProbableA code describing type of care team. 
 Care Team Category
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of type of care team 
- AltCodesArray of objectAlternate or translation codes for type of care team - Codestring, nullPossibleA code describing type of care team 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of type of care team 
 
 
- Organizationobjectundefined - IdentifiersArray of objectList of IDs specific to this organization - IDstring, nullProbableAn ID specific to this organization 
- IDTypestring, nullProbableThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Namenull, nullProbableThe name of the organization 
- Typeobject- Codestring, nullProbableA code describing the kind of organization 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the kind of organization 
- AltCodesArray of objectAlternate or translation codes for the kind of organization - Codestring, nullPossibleA code describing the kind of organization 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the kind of organization 
 
 
- AddressobjectThe address information for the organization - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
- Usestring, nullProbableUse 
 
- TelecomArray of objectPhone, fax, email, or other communication numbers for the organization - Valuenull, nullProbableThe phone number or telecommunications address 
- Usenull, nullProbableThe purpose of this telecommunications address (e.g. home, work, direct) 
- Systemnull, nullProbableThe form of this address (e.g. phone, email, fax). 
 Supported Values
 
 
- Encounterobject- IdentifiersArray of objectList of IDs specific to this encounter - IDstring, nullProbableAn ID specific to this encounter 
- IDTypestring, nullProbableThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Statusstring, nullProbableThe status of the encounter 
- Typeobject- Codestring, nullReliableA code describing the type of encounter (office visit, hospital, etc). 
 CPT-4
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the type of encounter (office visit, hospital, etc) 
- AltCodesArray of objectAlternate or translation codes for the type of encounter (office visit, hospital, etc) - Codestring, nullPossibleA code describing the type of encounter (office visit, hospital, etc) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of encounter (office visit, hospital, etc) 
 
 
- DateTimestring, nullReliableWhen the encounter took place, or alternatively when the encounter began if CareTeams[].Encounter.EndDateTime is present. 
 ISO 8601 Format
- EndDateTimestring, nullPossibleWhen the encounter was completed, if available. 
 ISO 8601 Format
 
- MembersArray of objectMembers of the care team - IdentifiersArray of objectList of IDs and ID Types that identify the concept - IDstring, nullReliableID for the concept 
- IDTypestring, nullReliableThe type of ID 
 
- FirstNamestring, nullFirst name of the care team member 
- MiddleNamestring, nullMiddle name of the care team member 
- LastNamestring, nullLast name of the care team member 
- CredentialsArray of stringCredentials of the care team member 
- AddressobjectPhysical address - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
- Usestring, nullProbableUse 
 
- TelecomArray of objectPhone, fax, email, or other communication numbers for the care team member - Valuenull, nullThe phone number or telecommunications address 
- Usenull, nullThe purpose of this telecommunications address (e.g. home, work, direct) 
- Systemnull, nullThe form of this address (e.g. phone, email, fax). 
 Supported Values
 
- StartDateTimestring, nullWhen the care team member joined the care team. 
 ISO 8601 Format
- EndDateTimestring, nullWhen the care team member left the care team. 
 ISO 8601 Format
- RolesArray of object- Codestring, nullProbableA code describing the roles of the care team member 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the roles of the care team member 
- AltCodesArray of objectAlternate or translation codes for the roles of the care team member - Codestring, nullPossibleA code describing the roles of the care team member 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the roles of the care team member 
 
 
 
 
- ChiefComplaintTextstring, nullReliableFree text chief complaint with any documented exposition. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- DischargeDiagnosisTextstring, nullPossibleFree text of the clinician's conclusions at time of Discharge. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- DischargeDiagnosisArray of objectAn array of diagnoses - StartDatestring, nullPossibleThe onset date of the diagnosis. 
 ISO 8601 Format
- EndDatestring, nullPossibleThe resolution date of the diagnosis. 
 ISO 8601 Format
- Statusobject- Codestring, nullPossibleA code describing the current state of the diagnosis (active, inactive, resolved). 
 HITSPProblemStatus
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the current state of the diagnosis (active, inactive, resolved) 
 
- IsNegativeIndicatorboolean, nullPossibleAbsent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true 
- Codestring, nullPossibleA code describing the diagnosis. 
 ICD9, ICD10, HCPC, CPT, SNOMED CT
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the diagnosis 
- AltCodesArray of objectAlternate or translation codes for the diagnosis - Codestring, nullPossibleA code describing the diagnosis 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the diagnosis 
 
- CommentsArray of objectFree text comments about the diagnosis. - Textstring, nullReliableThe plain text comment. 
 
 
- DischargeMedicationsTextstring, nullReliableFree text form of the medications summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- DischargeMedicationsArray of object- Prescriptionboolean, nullReliableWhether the medication is a prescription. 
 For a prescription: true. For a patient reported med, or a med administered by a provider: false
- FreeTextSigstring, nullPossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication 
- Doseobject- Quantitystring, nullProbableThe size of the dose for pills, capsules, etc. 
- Unitsstring, nullProbableThe units of the dose. 
 UCUM Units of Measure
 
- Rateobject- Quantitystring, nullProbableIf the medication is in liquid form, the rate at which it is administered 
- Unitsstring, nullProbableUnits for the rate. 
 UCUM Units of Measure
 
- Routeobject- Codestring, nullProbableA code describing the method by which the medication is delivered. 
 Medication Route FDA Value Set
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the method by which the medication is delivered 
- AltCodesArray of objectAlternate or translation codes for the method by which the medication is delivered - Codestring, nullPossibleA code describing the method by which the medication is delivered 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the method by which the medication is delivered 
 
 
- Statusstring, nullPossibleThe status of the medication. 
- StartDatestring, nullReliableWhen the medication was started. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen the medication ended. 
 ISO 8601 Format
- Frequencyobject- Periodstring, nullProbableHow often the patient should be taking the medication 
- PeriodMaxstring, nullPossibleHow often the patient should be taking the medication at a maximum 
- Unitstring, nullProbableUnits for how often the patient should be taking the medication. 
 UCUM Units of Measure
- EventCodestring, nullPossibleReal world event that describes the frequency. 
 HL7 Timing Event
- InstitutionSpecifiedboolean, nullPossibleIndicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".) 
 
- NumberOfRefillsRemainingnumber, nullPossibleThe number of authorized refills remaining on the prescription 
- TotalRefillsnumber, nullProbableThe total number of refills prescribed 
- LastRefillDatestring, nullProbableThe date the refill was last filled. 
 ISO 8601 Format
- IsPRNboolean, nullProbableWhether the medication is to be taken on an as-needed basis 
- Productobject- Codestring, nullReliableA code describing the actual medication given . 
 RxNorm
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the actual medication given 
- AltCodesArray of objectAlternate or translation codes for the actual medication given - Codestring, nullPossibleA code describing the actual medication given 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the actual medication given 
 
 
- IndicationsArray of object- Codestring, nullPossibleA code describing the reason the medication was given. 
 SNOMED CT
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the reason the medication was given 
- AltCodesArray of objectAlternate or translation codes for the reason the medication was given - Codestring, nullPossibleA code describing the reason the medication was given 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the reason the medication was given 
 
 
- SupplyOrderobject- StartDatestring, nullReliableWhen the medication supply order was starts. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen the medication supply order ends. 
 ISO 8601 Format
- Quantitystring, nullProbableThe quantity of the medication supply order 
- Unitsstring, nullProbableThe units of the supply order. 
 UCUM Units of Measure
- NumberOfRefillsRemainingnumber, nullPossibleThe number of authorized refills remaining on the medication supply order 
 
- AdministrationHistoryArray of objectA list of recent administrations of this medication - StartDatestring, nullPossibleWhen the medication administration was started. 
 ISO 8601 Format
- EndDatestring, nullPossibleWhen the medication administration ended. 
 ISO 8601 Format
 
 
- EncountersTextstring, nullProbableFree text form of the encounters summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- EncountersArray of object- IdentifiersArray of objectList of IDs specific to this encounter - IDstring, nullProbableAn ID specific to this encounter 
- IDTypestring, nullProbableThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Statusstring, nullProbableThe status of the encounter 
- Typeobject- Codestring, nullReliableA code describing the type of encounter (office visit, hospital, etc). 
 CPT-4
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the type of encounter (office visit, hospital, etc) 
- AltCodesArray of objectAlternate or translation codes for the type of encounter (office visit, hospital, etc) - Codestring, nullPossibleA code describing the type of encounter (office visit, hospital, etc) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of encounter (office visit, hospital, etc) 
 
 
- DateTimestring, nullReliableWhen the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present. 
 ISO 8601 Format
- EndDateTimestring, nullPossibleWhen the encounter was completed, if available. 
 ISO 8601 Format
- ProvidersArray of object- NPIstring, nullProbableNPI of the Encounter Providers 
- IDstring, nullProbableID of the Encounter Providers. 
 This ID is often required for Inpatient Visits.
- IDTypestring, nullProbableID type of the ID for the Encounter Providers 
- FirstNamestring, nullPossibleFirst name of the Encounter Providers 
- LastNamestring, nullPossibleLast name of the Encounter Providers 
- CredentialsArray of stringList of credentials for the Encounter Providers. 
 e.g. MD, PhD
- AddressobjectProvider's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- EmailAddressesArray of stringProvider's email address(es) 
- PhoneNumberobject- Officestring, nullPossibleProvider's office phone number. 
 In E. 164 Format. (e.g. +16085551234)
 
- LocationobjectProvider's location - Typestring, nullPossibleType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullPossibleFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullPossibleAn ID specific to this facility 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullPossibleDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullPossibleAn ID specific to this department 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullPossibleRoom. 
 Example: 136
 
- Roleobject- Codestring, nullProbableA code describing the role of the provider (pcp, general physician, etc.) 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the role of the provider (pcp, general physician, etc.) 
- AltCodesArray of objectAlternate or translation codes for the role of the provider (pcp, general physician, etc.) - Codestring, nullPossibleA code describing the role of the provider (pcp, general physician, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the role of the provider (pcp, general physician, etc.) 
 
 
 
- LocationsArray of object- IdentifiersArray of objectList of IDs specific to this location - IDstring, nullProbableAn ID specific to this location 
- IDTypestring, nullProbableThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- TelecomArray of objectPhone, fax, email, or other communication numbers for the location - Valuenull, nullProbableThe phone number or telecommunications address 
- Usenull, nullProbableThe purpose of this telecommunications address (e.g. home, work, direct) 
- Systemnull, nullProbableThe form of this address (e.g. phone, email, fax). 
 Supported Values
 
- Addressobject- StreetAddressstring, nullProbable
- Citystring, nullProbable
- Statestring, nullProbable
- Countrystring, nullProbable
- ZIPstring, nullProbable
 
- Typeobject- Codestring, nullProbableA code describing the type of location where the patient was seen (clinic, urgent care, hospital). 
 Healthcare Service Location
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the type of location where the patient was seen (clinic, urgent care, hospital) 
- AltCodesArray of objectAlternate or translation codes for the type of location where the patient was seen (clinic, urgent care, hospital) - Codestring, nullPossibleA code describing the type of location where the patient was seen (clinic, urgent care, hospital) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of location where the patient was seen (clinic, urgent care, hospital) 
 
 
- Namestring, nullProbableThe name of the location 
 
- DiagnosisArray of objectAn array of diagnoses - StartDatestring, nullProbableThe onset date of the diagnosis. 
 ISO 8601 Format
- EndDatestring, nullProbableThe resolution date of the diagnosis. 
 ISO 8601 Format
- Statusobject- Codestring, nullPossibleA code describing the current state of the diagnosis (active, inactive, resolved). 
 HITSPProblemStatus
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the current state of the diagnosis (active, inactive, resolved) 
 
- IsNegativeIndicatorboolean, nullPossibleAbsent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true 
- Codestring, nullProbableA code describing the diagnosis. 
 ICD9, ICD10, HCPC, CPT, SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the diagnosis 
- AltCodesArray of objectAlternate or translation codes for the diagnosis - Codestring, nullPossibleA code describing the diagnosis 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the diagnosis 
 
- CommentsArray of objectFree text comments about the diagnosis. - Textstring, nullReliableThe plain text comment. 
 
 
- ReasonForVisitArray of object- Codestring, nullProbableA code describing the reason for the encounter (usually this is what the patient reports). 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the reason for the encounter (usually this is what the patient reports) 
- AltCodesArray of objectAlternate or translation codes for the reason for the encounter (usually this is what the patient reports) - Codestring, nullPossibleA code describing the reason for the encounter (usually this is what the patient reports) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the reason for the encounter (usually this is what the patient reports) 
 
 
- DischargeDispositionobject- Codestring, nullProbableA code describing the discharge disposition of the visit. 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the discharge disposition of the visit. 
- AltCodesArray of objectAlternate or translation codes for the discharge disposition of the visit. - Codestring, nullPossibleA code describing the discharge disposition of the visit. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the discharge disposition of the visit. 
 
 
 
- FamilyHistoryTextstring, nullProbableFree text form of the family history summary 
- FamilyHistoryArray of objectEach element of the FamilyHistory is one person in the patient's family. - Relationobject- Codestring, nullReliableA code describing the family member's relationship (father, mother, maternal grandfather, etc.). 
 [HL7 Family History Related Subjects](http://www.hl7.org/documentcenter/private/standards/cda/r2/cda_r2_normativewebeditio n2010.zip)
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the family member's relationship (father, mother, maternal grandfather, etc.) 
- Demographicsobject- Sexstring, nullProbableValue SetGender of the relative 
- DOBstring, nullProbableDate of Birth of the relative. 
 In YYYY-MM-DD format
 
- IsDeceasedboolean, nullProbableWhether or not the relative is deceased 
 
- ProblemsArray of objectA list of the relative's relevant health problems - Codestring, nullReliableA code describing a particular problem experienced by the relative. 
 SNOMED CT
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of a particular problem experienced by the relative 
- AltCodesArray of objectAlternate or translation codes for a particular problem experienced by the relative - Codestring, nullPossibleA code describing a particular problem experienced by the relative 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of a particular problem experienced by the relative 
 
- Typeobject- Codestring, nullReliableA code describing the general class of the problem. (disease, problem, etc.). 
 Problem Type Value Set
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the general class of the problem. (disease, problem, etc.) 
 
- DateTimestring, nullProbableThe time when the problem started. 
 ISO 8601 Format
- AgeAtOnsetstring, nullProbableThe relative's age when the problem started 
- IsCauseOfDeathboolean, nullProbableFlag indicating whether or not this problem was the cause of death for the relative. 
 
 
- FunctionalStatusTextstring, nullPossibleFree text form of the functional status summary 
- FunctionalStatusobject- ObservationsArray of objectVarious types of observations about the patient's functional status. - Codestring, nullProbableA code describing a type of observation (functional status, activities of daily living, sensory status, etc.). . 
 LOINC
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of a type of observation (functional status, activities of daily living, sensory status, etc.). 
- AltCodesArray of objectAlternate or translation codes for a type of observation (functional status, activities of daily living, sensory status, etc.). - Codestring, nullPossibleA code describing a type of observation (functional status, activities of daily living, sensory status, etc.). 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of a type of observation (functional status, activities of daily living, sensory status, etc.). 
 
- DateTimestring, nullProbableA specific date/time when the value was recorded. 
 ISO 8601 Format
- CodedValueobject- Codestring, nullPossibleA code describing the individual observation value, if a coded value. 
 Only populated if the functional status is sent as a coded value. Observations[].CodedValue.Name will be duplicated in Observations[].Value
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the individual observation value, if a coded value. 
- AltCodesArray of objectAlternate or translation codes for the individual observation value, if a coded value. - Codestring, nullPossibleA code describing the individual observation value, if a coded value. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the individual observation value, if a coded value. 
 
 
- Valuestring, nullProbableThe measurement recorded for the functional status observation. 
- Unitsstring, nullProbableThe units of the measurement. 
 UCUM Units of Measure
- ReferenceRangeobjectReference range for the result. 
 Numeric observation values will use the low and high properties. Non-numeric observation values will put the normal value in the text property.- Lownumber, nullPossibleLower bound for a normal observation 
- Highnumber, nullPossibleUpper bound for a normal observation 
- Textstring, nullPossibleThe normal value for non-numeric observations 
 
- CommentsArray of objectFree text comments about the observation. - Textstring, nullReliableThe plain text comment. 
 
 
- SuppliesArray of objectNon-medicinal supplies provided to the patient in the context of assessing the patient's physical abilities. - Codestring, nullProbableA code describing the supplied product. 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the supplied product 
- AltCodesArray of objectAlternate or translation codes for the supplied product - Codestring, nullPossibleA code describing the supplied product 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the supplied product 
 
- Statusstring, nullProbableThe state of the supplied product (intent, confirmed, etc). 
 Plan of care status
- DateTimestring, nullProbableThe date/time of the activity. . 
 ISO 8601 Format
 
 
- GoalsTextstring, nullProbableFree text form of the goals summary 
- GoalsArray of objectList of goals or targets for patient care. - Codestring, nullProbableA code describing the patient health goal. 
 LOINC
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the patient health goal. 
- AltCodesArray of objectAlternate or translation codes for the patient health goal. - Codestring, nullPossibleA code describing the patient health goal. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the patient health goal. 
 
- DateTimestring, nullProbableA specific date/time when the goal was recorded. 
 ISO 8601 Format
- CodedValueobject- Codestring, nullPossibleA code describing the individual goal or target value, if a coded value. 
 Only populated if the goal is sent as a coded value. CodedValue.Name will be duplicated in Value
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the individual goal or target value, if a coded value. 
- AltCodesArray of objectAlternate or translation codes for the individual goal or target value, if a coded value. - Codestring, nullPossibleA code describing the individual goal or target value, if a coded value. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the individual goal or target value, if a coded value. 
 
 
- Valuestring, nullProbableThe individual goal or target value. 
- Unitsstring, nullProbableThe units of the measurement. 
 UCUM Units of Measure
- StartDatestring, nullProbableStart date of goal. 
- EndDatestring, nullProbableTarget completion date for goal. 
- Priorityobject- Codestring, nullPossibleA code describing the level of importance associated with the goal. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the level of importance associated with the goal. 
 
- AchievementStatusobject- Codestring, nullPossibleA code describing progression, or lack thereof, towards the goal. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of progression, or lack thereof, towards the goal. 
 
- MilestonesArray of objectList of goals or targets for patient care. - Codestring, nullProbableA code describing the patient health goal. 
 LOINC
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the patient health goal. 
- AltCodesArray of objectAlternate or translation codes for the patient health goal. - Codestring, nullPossibleA code describing the patient health goal. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the patient health goal. 
 
- DateTimestring, nullProbableA specific date/time when the goal was recorded. 
 ISO 8601 Format
- CodedValueobject- Codestring, nullPossibleA code describing the individual goal or target value, if a coded value. 
 Only populated if the goal is sent as a coded value. CodedValue.Name will be duplicated in Value
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the individual goal or target value, if a coded value. 
- AltCodesArray of objectAlternate or translation codes for the individual goal or target value, if a coded value. - Codestring, nullPossibleA code describing the individual goal or target value, if a coded value. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the individual goal or target value, if a coded value. 
 
 
- Valuestring, nullProbableThe individual goal or target value. 
- Unitsstring, nullProbableThe units of the measurement. 
 UCUM Units of Measure
- StartDatestring, nullProbableStart date of goal. 
- EndDatestring, nullProbableTarget completion date for goal. 
- Priorityobject- Codestring, nullPossibleA code describing the level of importance associated with the goal. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the level of importance associated with the goal. 
 
- AchievementStatusobject- Codestring, nullPossibleA code describing progression, or lack thereof, towards the goal. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of progression, or lack thereof, towards the goal. 
 
 
- CommentsArray of objectFree text comments about the goal. - Textstring, nullReliableThe plain text comment. 
 
 
- HealthConcernsTextstring, nullReliableFree text form of the health concerns summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- HealthConcernsArray of objectAn array of all of patient relevant health concerns, current and historical. - ConcernTypestring, nullReliableThe kind of FHIR resource this health concern would map to. For example, problems would map to Condition, and vital signs would map to Observation. 
 Condition | Observation
- Categoryobject- Codestring, nullReliableA code describing a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs. 
 Example codes: Condition Category Codes and Observation Category Codes
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs. 
- AltCodesArray of objectAlternate or translation codes for a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs. - Codestring, nullPossibleA code describing a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs. 
 
 
- StartDatestring, nullProbableWhen the health concern was noticed. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen the health concern stopped (if it is not current). 
 ISO 8601 Format
- Codestring, nullReliableA code describing the actual health concern. 
 LOINC or SNOMED CT
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the actual health concern 
- AltCodesArray of objectAlternate or translation codes for the actual health concern - Codestring, nullPossibleA code describing the actual health concern 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the actual health concern 
 
- Valuenull, nullPossibleObserved value, required if the concern is an observation. 
- Unitsnull, nullPossibleThe units of measurement if the concern is an observation. 
 UCUM Units of Measure
- Interpretationstring, nullPossibleA flag indicating whether or not the observed value is normal, high, or low. 
 Supported Values
- TargetSiteobject- Codestring, nullPossibleA code describing the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected. 
- AltCodesArray of objectAlternate or translation codes for the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected. - Codestring, nullPossibleA code describing the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected. 
 
 
- Statusstring, nullProbableThe current state of the health concern (active, inactive) 
- CommentsArray of objectFree text comments about the health concern. - Textstring, nullReliableThe plain text comment. 
 
 
- HistoryOfPresentIllnessTextstring, nullProbableFree 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.
- ImmunizationTextstring, nullProbableFree text form of the immunization summary 
- ImmunizationsArray of objectArray of immunizations for patient. - DateTimestring, nullReliableWhen the immunization was given. 
 ISO 8601 Format
- Routeobject- Codestring, nullProbableA code describing the way in which the immunization was delivered (intramuscular, oral, etc.). 
 [Medication Route FDA Value Set](http://www.fda.gov/ForIndustry/DataStandards/StructuredProductLabeling /ucm162034.htm)
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the way in which the immunization was delivered (intramuscular, oral, etc.) 
- AltCodesArray of objectAlternate or translation codes for the way in which the immunization was delivered (intramuscular, oral, etc.) - Codestring, nullPossibleA code describing the way in which the immunization was delivered (intramuscular, oral, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the way in which the immunization was delivered (intramuscular, oral, etc.) 
 
 
- Statusstring, nullPossibleThe status of the immunization. 
- Productobject- Manufacturerstring, nullProbableName of organization that manufacture the immunization. 
 Free text
- Codestring, nullReliableA code describing the vaccination that was given. 
 CVX code system
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the vaccination that was given 
- AltCodesArray of objectAlternate or translation codes for the vaccination that was given - Codestring, nullPossibleA code describing the vaccination that was given 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the vaccination that was given 
 
- LotNumberstring, nullProbableThe lot number of the vaccine 
 
- Doseobject- Quantitystring, nullProbableThe size of the dose 
- Unitsstring, nullProbableThe units of the dose. 
 UCUM Units of Measure
 
- ReasonNotGivenstring, nullPossibleIf this immunization was not administered, this will contain the reason not given. If null, then the immunization was administered normally. 
 FHIR Immunization Status Reason Codes
- AdministrationHistoryArray of objectA list of recent administrations of this immunization - StartDatestring, nullPossibleWhen the immunization administration was started. 
 ISO 8601 Format
- EndDatestring, nullPossibleWhen the immunization administration ended. 
 ISO 8601 Format
 
 
- InstructionsTextstring, nullReliableFree text patient education and/or instructions. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- InstructionsArray of object- Codestring, nullReliableA code describing code for the type of instruction. 
 Patient Education
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (SNOMED CT preferred). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of code for the type of instruction. 
- AltCodesArray of objectAlternate or translation codes for code for the type of instruction. - Codestring, nullPossibleA code describing code for the type of instruction. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (SNOMED CT preferred). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of code for the type of instruction. 
 
- Textstring, nullReliableFree text contents of the patient instruction 
 
- InsurancesTextstring, nullPossibleFree text form of the patient's insurances. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- InsurancesArray of objectList of insurance coverages for the patient - Planobject- IDstring, nullProbableIdentifier of insurance plan 
- IDTypestring, nullProbableID type of insurance plan 
- Namestring, nullProbableName of insurance plan 
- Typestring, nullPossibleType of insurance plan 
 
- MemberNumberstring, nullPossiblePatient member number 
- Companyobject- IDstring, nullPossibleID of insurance company (payor). 
 Typically not available in ClinicalSummary.
- IDTypestring, nullPossibleID type of insurance company (payor). 
 Typically not available in ClinicalSummary.
- Namestring, nullProbableName of insurance company (payor) 
- AddressobjectInsurance company's address - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
- Usestring, nullProbableUse 
 
- PhoneNumberstring, nullProbableInsurance companys phone number. 
 In E. 164 Format (i.e. +16085551234)
 
- GroupNumberstring, nullProbableInsurance policy group number 
- GroupNamestring, nullPossibleInsurance policy group name. 
 Typically not available in ClinicalSummary.
- EffectiveDatestring, nullProbableEffect date of this insurance policy. 
 In YYYY-MM-DD format
- ExpirationDatestring, nullProbableExpiration date of this insurance policy. 
 In YYYY-MM-DD format
- PolicyNumberstring, nullProbableInsurance policy number 
- Prioritystring, nullPossibleValue SetThe insurance priority sequence. 
 If the insurance works in conjunction with other insurance plans, this field contains priority sequence.
- AgreementTypestring, nullPossibleType of insurance agreement. 
 Typically not available in ClinicalSummary.
- CoverageTypestring, nullProbableValue SetType of insurance agreement. 
 Indicates who will be receiving the bill for the service.
- InsuredobjectIndividual who has the agreement with the insurance company for the related policy - IdentifiersArray of objectList of IDs and ID types that identify the insured - IDstring, nullPossibleID for the insured 
- IDTypestring, nullPossibleType of ID. 
 E.g. MRN, EPI
 
- LastNamestring, nullPossibleLast name of the insured 
- MiddleNamestring, nullPossibleMiddle name of the insured 
- FirstNamestring, nullPossibleFirst name of the insured 
- SSNstring, nullPossibleInsured's social security number 
- Relationshipstring, nullPossibleValue SetRelationship of the insured to the patient 
- DOBstring, nullPossibleDate of birth of the insured. 
 In YYYY-MM-DD format
- Sexstring, nullPossibleValue SetSex of the insured 
- AddressobjectAddress of the insured - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
- Usestring, nullProbableUse 
 
 
 
- InterventionsTextstring, nullReliableFree 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.
- MedicalEquipmentTextstring, nullProbableFree text form of the medical equipment summary 
- MedicalEquipmentArray of objectA list of medical equipment that the patient uses (cane, pacemakers, etc.) - Statusstring, nullReliableThe current status of the equipment (active, completed, etc.) 
- StartDatestring, nullProbableWhen the equipment was first put into use. 
 ISO 8601 Format
- Quantitystring, nullProbableThe number of products used 
- CommentsArray of objectFree text comments about the device or equipment. - Textstring, nullReliableThe plain text comment. 
 
- Productobject- Codestring, nullProbableA code describing the actual product. 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the actual product. 
- AltCodesArray of objectAlternate or translation codes for the actual product. - Codestring, nullPossibleA code describing the actual product. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the actual product. 
 
- IdentifiersArray of objectIdentifiers for the equipement or device. 
 Unique Device Identifier (UDI) components are present in other fields.- IDstring, nullProbableID for the equipment or device 
- IDTypestring, nullProbableType of ID 
 
- DeviceIDstring, nullProbableThe device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. 
- Issuerstring, nullProbableOrganization that is charged with issuing UDIs for devices. 
 GS1, HIBCC, ICCBBA, ICCBA
- SerialNumberstring, nullProbableThe device serial number 
- DistinctIDstring, nullProbableThe distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product. 
- ManufacturerNamestring, nullProbableThe name of the manufacturer 
- LotNumberstring, nullProbableLot or batch number assigned by the manufacturer 
- ManufactureDatestring, nullProbableThe date the product was manufactured. 
 In ISO 8601 format
- ExpirationDatestring, nullProbableThe date and time beyond which this device is no longer valid or should not be used (if applicable). 
 In ISO 8601 format
- BrandNamestring, nullProbableThe name of the device as given by the manufacturer 
- ModelNumberstring, nullProbableThe manufacturer's model number for the device 
- CatalogNumberstring, nullProbableThe part number or catalog number of the device 
- Statusobject- Codestring, nullProbableA code describing the status of the patient's implantable medical device. 
 Implantable Device Status Value Set
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the status of the patient's implantable medical device 
 
- SafetyObservationsArray of object- Codestring, nullProbableA code describing additional safety characteristics about a medical device. for example devices containing latex. 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of additional safety characteristics about a medical device. for example devices containing latex. 
- AltCodesArray of objectAlternate or translation codes for additional safety characteristics about a medical device. for example devices containing latex. - Codestring, nullPossibleA code describing additional safety characteristics about a medical device. for example devices containing latex. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of additional safety characteristics about a medical device. for example devices containing latex. 
 
 
 
- Procedureobject- Codestring, nullProbableA code describing the procedure performed during which the device was implanted 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the procedure performed during which the device was implanted 
- AltCodesArray of objectAlternate or translation codes for the procedure performed during which the device was implanted - Codestring, nullPossibleA code describing the procedure performed during which the device was implanted 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the procedure performed during which the device was implanted 
 
- TargetSiteobject- Codestring, nullProbableA code describing the location on the body where the device was implanted 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the location on the body where the device was implanted 
- AltCodesArray of objectAlternate or translation codes for the location on the body where the device was implanted - Codestring, nullPossibleA code describing the location on the body where the device was implanted 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the location on the body where the device was implanted 
 
 
 
 
- MedicationsTextstring, nullReliableFree text form of the medications summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- MedicationsArray of object- Prescriptionboolean, nullReliableWhether the medication is a prescription. 
 For a prescription: true. For a patient reported med, or a med administered by a provider: false
- FreeTextSigstring, nullPossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication 
- Doseobject- Quantitystring, nullProbableThe size of the dose for pills, capsules, etc. 
- Unitsstring, nullProbableThe units of the dose. 
 UCUM Units of Measure
 
- Rateobject- Quantitystring, nullProbableIf the medication is in liquid form, the rate at which it is administered 
- Unitsstring, nullProbableUnits for the rate. 
 UCUM Units of Measure
 
- Routeobject- Codestring, nullProbableA code describing the method by which the medication is delivered. 
 Medication Route FDA Value Set
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the method by which the medication is delivered 
- AltCodesArray of objectAlternate or translation codes for the method by which the medication is delivered - Codestring, nullPossibleA code describing the method by which the medication is delivered 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the method by which the medication is delivered 
 
 
- Statusstring, nullPossibleThe status of the medication. 
- StartDatestring, nullReliableWhen the medication was started. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen the medication ended. 
 ISO 8601 Format
- Frequencyobject- Periodstring, nullProbableHow often the patient should be taking the medication 
- PeriodMaxstring, nullPossibleHow often the patient should be taking the medication at a maximum 
- Unitstring, nullProbableUnits for how often the patient should be taking the medication. 
 UCUM Units of Measure
- EventCodestring, nullPossibleReal world event that describes the frequency. 
 HL7 Timing Event
- InstitutionSpecifiedboolean, nullPossibleIndicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".) 
 
- NumberOfRefillsRemainingnumber, nullPossibleThe number of authorized refills remaining on the prescription 
- TotalRefillsnumber, nullProbableThe total number of refills prescribed 
- LastRefillDatestring, nullProbableThe date the refill was last filled. 
 ISO 8601 Format
- IsPRNboolean, nullProbableWhether the medication is to be taken on an as-needed basis 
- Productobject- Codestring, nullReliableA code describing the actual medication given . 
 RxNorm
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the actual medication given 
- AltCodesArray of objectAlternate or translation codes for the actual medication given - Codestring, nullPossibleA code describing the actual medication given 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the actual medication given 
 
 
- IndicationsArray of object- Codestring, nullPossibleA code describing the reason the medication was given. 
 SNOMED CT
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the reason the medication was given 
- AltCodesArray of objectAlternate or translation codes for the reason the medication was given - Codestring, nullPossibleA code describing the reason the medication was given 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the reason the medication was given 
 
 
- SupplyOrderobject- StartDatestring, nullReliableWhen the medication supply order was starts. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen the medication supply order ends. 
 ISO 8601 Format
- Quantitystring, nullProbableThe quantity of the medication supply order 
- Unitsstring, nullProbableThe units of the supply order. 
 UCUM Units of Measure
- NumberOfRefillsRemainingnumber, nullPossibleThe number of authorized refills remaining on the medication supply order 
 
- AdministrationHistoryArray of objectA list of recent administrations of this medication - StartDatestring, nullPossibleWhen the medication administration was started. 
 ISO 8601 Format
- EndDatestring, nullPossibleWhen the medication administration ended. 
 ISO 8601 Format
 
 
- MedicationsAdministeredTextstring, nullReliableFree text form of the administered medications summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- MedicationsAdministeredArray of object- FreeTextSigstring, nullPossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication 
- Doseobject- Quantitystring, nullProbableThe size of the dose for pills, capsules, etc. 
- Unitsstring, nullProbableThe units of the dose. 
 UCUM Units of Measure
 
- Rateobject- Quantitystring, nullProbableIf the medication is in liquid form, the rate at which it is administered 
- Unitsstring, nullProbableUnits for the rate. 
 UCUM Units of Measure
 
- Routeobject- Codestring, nullProbableA code describing the method by which the medication is delivered. 
 Medication Route FDA Value Set
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the method by which the medication is delivered 
- AltCodesArray of objectAlternate or translation codes for the method by which the medication is delivered - Codestring, nullPossibleA code describing the method by which the medication is delivered 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the method by which the medication is delivered 
 
 
- Statusstring, nullPossibleThe status of the medication 
- StartDatestring, nullReliableWhen the medication was started. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen 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
- Frequencyobject- Periodstring, nullProbableHow often the patient should be taking the medication. 
 UCUM Units of Measure
- Unitstring, nullProbableUnits for how often the patient should be taking the medication 
 
- IsPRNboolean, nullProbableWhether the medication is to be taken on an as-needed basis 
- Productobject- Codestring, nullReliableA code describing the actual medication given . 
 RxNorm
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the actual medication given 
- AltCodesArray of objectAlternate or translation codes for the actual medication given - Codestring, nullPossibleA code describing the actual medication given 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the actual medication given 
 
 
- ReasonNotGivenstring, nullPossibleIf this medication was not administered, this will contain the reason not given. If null, then the medication was administered normally. 
 FHIR Reason Medication Not Given Codes
- AdministrationHistoryArray of objectA list of recent administrations of this medication - StartDatestring, nullPossibleWhen the medication administration was started. 
 ISO 8601 Format
- EndDatestring, nullPossibleWhen the medication administration ended. 
 ISO 8601 Format
 
 
- ObjectiveTextstring, nullReliableFree 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.
- PhysicalExamTextstring, nullReliableFree text regarding the physical exam, observations by clinician. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- PlanOfCareTextstring, nullProbableFree text form of the plan of care summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- PlanOfCareobject- OrdersArray of objectFuture lab tests or other diagnostic procedures. - Codestring, nullProbableA code describing the test to be performed . 
 LOINC
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the test to be performed 
- AltCodesArray of objectAlternate or translation codes for the test to be performed - Codestring, nullPossibleA code describing the test to be performed 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the test to be performed 
 
- Statusstring, nullProbableThe state of the plan (intent, confirmed, etc). 
 Plan of care status
- DateTimestring, nullProbable
 
- ProceduresArray of objectFuture procedures. - Codestring, nullProbableA code describing the planned procedure, such as an appendectomy or hip replacement . 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the planned procedure, such as an appendectomy or hip replacement 
- AltCodesArray of objectAlternate or translation codes for the planned procedure, such as an appendectomy or hip replacement - Codestring, nullPossibleA code describing the planned procedure, such as an appendectomy or hip replacement 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the planned procedure, such as an appendectomy or hip replacement 
 
- Statusstring, nullProbableThe state of the plan (intent, confirmed, etc). 
 Plan of care status
- DateTimestring, nullProbable
 
- EncountersArray of objectAppointments and other upcoming encounters - Codestring, nullProbableA code describing the planned encounter type . 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the planned encounter type 
- AltCodesArray of objectAlternate or translation codes for the planned encounter type - Codestring, nullPossibleA code describing the planned encounter type 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the planned encounter type 
 
- IdentifiersArray of objectList of IDs and ID types that identifies the encounter - IDstring, nullPossibleID for the encounter 
- IDTypestring, nullPossibleType of ID 
 
- Statusstring, nullProbableThe state of the plan (intent, confirmed, etc). 
 Plan of care status
- DateTimestring, nullProbable
 
- MedicationAdministrationArray of objectPlanned medication - FreeTextSigstring, nullPossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication 
- Statusstring, nullProbableThe state of the plan (intent, confirmed, etc). 
 Plan of care status
- Doseobject- Quantitystring, nullProbableThe size of the dose for pills, capsules, etc. 
- Unitsstring, nullProbableThe units of the dose. 
 UCUM Units of Measure
 
- Rateobject- Quantitystring, nullProbableIf the medication is not in does form, this is the rate at which is administered 
- Unitsstring, nullProbableUnits for the rate. 
 UCUM Units of Measure
 
- Routeobject- Codestring, nullProbableA code describing the method by which the medication is to be delivered. 
 Medication Route FDA Value Set
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the method by which the medication is to be delivered 
- AltCodesArray of objectAlternate or translation codes for the method by which the medication is to be delivered - Codestring, nullPossibleA code describing the method by which the medication is to be delivered 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the method by which the medication is to be delivered 
 
 
- StartDatestring, nullProbableWhen the medication was started 
- EndDatestring, nullProbableWhen the medication ended 
- Frequencyobject- Periodstring, nullProbableHow often the patient should be taking the medication. 
 UCUM Units of measure
- Unitstring, nullProbableUnits for how often the patient should be taking the medication 
 
- IsPRNboolean, nullProbableWhether the medication is to be taken on an as-needed basis 
- Productobject- Codestring, nullProbableA code describing the planned medication . 
 RxNorm
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the planned medication 
- AltCodesArray of objectAlternate or translation codes for the planned medication - Codestring, nullPossibleA code describing the planned medication 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the planned medication 
 
 
 
- SuppliesArray of objectFuture supplies that a patient may be given, including implants. - Codestring, nullProbableA code describing the planned product. 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the planned product 
- AltCodesArray of objectAlternate or translation codes for the planned product - Codestring, nullPossibleA code describing the planned product 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the planned product 
 
- Statusstring, nullProbableThe state of the plan (intent, confirmed, etc). 
 Plan of care status
- DateTimestring, nullProbableThe scheduled time of the activity. . 
 ISO 8601 Format
 
- ServicesArray of objectPlanned activities that are service-oriented in nature, such as a dressing change, or feeding a patient. - Codestring, nullProbableA code describing the planned activity. 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the planned activity. 
- AltCodesArray of objectAlternate or translation codes for the planned activity. - Codestring, nullPossibleA code describing the planned activity. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the planned activity. 
 
- Statusstring, nullProbableThe state of the plan (intent, confirmed, etc). 
 Plan of care status
- DateTimestring, nullProbableThe scheduled time of the activity. . 
 ISO 8601 Format
 
 
- ProblemsTextstring, nullReliableFree text form of the problems summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- ProblemsArray of objectAn array of all of patient relevant problems, both current and historical. - StartDatestring, nullProbableWhen the problem was noticed. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen the problem stopped (if it is not current). 
 ISO 8601 Format
- Codestring, nullReliableA code describing the actual problem . 
 SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009)
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the actual problem 
- AltCodesArray of objectAlternate or translation codes for the actual problem - Codestring, nullPossibleA code describing the actual problem 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the actual problem 
 
- Categoryobject- Codestring, nullReliableA code describing the type of problem this is (complaint, diagnosis, symptom, etc.) 
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the type of problem this is (complaint, diagnosis, symptom, etc.) 
- AltCodesArray of objectAlternate or translation codes for the type of problem this is (complaint, diagnosis, symptom, etc.) - Codestring, nullPossibleA code describing the type of problem this is (complaint, diagnosis, symptom, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of problem this is (complaint, diagnosis, symptom, etc.) 
 
 
- Statusobject- Codestring, nullProbableA code describing the current state of the problem (active, inactive, resolved). 
 HITSPProblemStatus
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the current state of the problem (active, inactive, resolved) 
 
- Commentstring, nullPossibleFree text comment about the problem. 
 This field is slated to be deprecated in favor of Comments[].Text
- CommentsArray of objectFree text comments about the problem. - Textstring, nullReliableThe plain text comment. 
 
- HealthStatusobject- Codestring, nullPossibleA code describing the effect of the problem on the patient (chronically ill, in remission, etc.). 
 SNOMED-CT
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the effect of the problem on the patient (chronically ill, in remission, etc.) 
- AltCodesArray of objectAlternate or translation codes for the effect of the problem on the patient (chronically ill, in remission, etc.) - Codestring, nullPossibleA code describing the effect of the problem on the patient (chronically ill, in remission, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the effect of the problem on the patient (chronically ill, in remission, etc.) 
 
 
 
- ProceduresTextstring, nullProbableFree text form of the procedures summary 
- ProceduresobjectA general grouper for all things that CDA considers procedures, grouped into three kinds. -Observations - procedures which result in new information about a patient. -Procedures - procedures whose immediate and primary outcome is the alteration of the physical condition of the patient. -Services (Sometimes called Acts) - procedures which cannot be classified as an observation or a procedure, such as a dressing change, feeding, or teaching. - ObservationsArray of objectThese are procedures that are more observational in nature, such as an EEG or EKG. - Codestring, nullProbableA code describing the procedure that was performed. . 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the procedure that was performed. 
- AltCodesArray of objectAlternate or translation codes for the procedure that was performed. - Codestring, nullPossibleA code describing the procedure that was performed. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the procedure that was performed. 
 
- DateTimestring, nullProbableWhen the procedure was performed. 
- Statusstring, nullProbableThe status of the procedure. 
- TargetSiteobject- Codestring, nullProbableA code describing the location on the body where the procedure was performed. 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the location on the body where the procedure was performed 
- AltCodesArray of objectAlternate or translation codes for the location on the body where the procedure was performed - Codestring, nullPossibleA code describing the location on the body where the procedure was performed 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the location on the body where the procedure was performed 
 
 
- CommentsArray of objectFree text comments about the procedure. - Textstring, nullReliableThe plain text comment. 
 
 
- ProceduresArray of objectThese are procedures that alter the state of the body, such as an appendectomy or hip replacement. - Codestring, nullProbableA code describing the procedure that was performed. . 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the procedure that was performed. 
- AltCodesArray of objectAlternate or translation codes for the procedure that was performed. - Codestring, nullPossibleA code describing the procedure that was performed. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the procedure that was performed. 
 
- DateTimestring, nullProbableWhen the procedure was performed. 
- Statusstring, nullProbableThe status of the procedure. 
- TargetSiteobject- Codestring, nullProbableA code describing the location on the body where the procedure was performed. 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the location on the body where the procedure was performed 
- AltCodesArray of objectAlternate or translation codes for the location on the body where the procedure was performed - Codestring, nullPossibleA code describing the location on the body where the procedure was performed 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the location on the body where the procedure was performed 
 
 
- CommentsArray of objectFree text comments about the procedure. - Textstring, nullReliableThe plain text comment. 
 
 
- ServicesArray of objectThese are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient. - Codestring, nullProbableA code describing the procedure that was performed. . 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the procedure that was performed. 
- AltCodesArray of objectAlternate or translation codes for the procedure that was performed. - Codestring, nullPossibleA code describing the procedure that was performed. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the procedure that was performed. 
 
- DateTimestring, nullProbableWhen the procedure was performed. 
- Statusstring, nullProbableThe status of the procedure. 
- CommentsArray of objectFree text comments about the procedure. - Textstring, nullReliableThe plain text comment. 
 
 
 
- ResolvedProblemsTextstring, nullReliableFree text form of the problems summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- ResolvedProblemsArray of objectAn array of historical problems and diagnoses that are no longer being tracked. - StartDatestring, nullProbableWhen the problem was noticed. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen the problem stopped (if it is not current). 
 ISO 8601 Format
- Codestring, nullReliableA code describing the actual problem . 
 SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009)
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the actual problem 
- AltCodesArray of objectAlternate or translation codes for the actual problem - Codestring, nullPossibleA code describing the actual problem 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the actual problem 
 
- Categoryobject- Codestring, nullReliableA code describing the type of problem this is (complaint, diagnosis, symptom, etc.) 
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the type of problem this is (complaint, diagnosis, symptom, etc.) 
- AltCodesArray of objectAlternate or translation codes for the type of problem this is (complaint, diagnosis, symptom, etc.) - Codestring, nullPossibleA code describing the type of problem this is (complaint, diagnosis, symptom, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of problem this is (complaint, diagnosis, symptom, etc.) 
 
 
- Statusobject- Codestring, nullProbableA code describing the current state of the problem (active, inactive, resolved). 
 HITSPProblemStatus
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the current state of the problem (active, inactive, resolved) 
 
- Commentstring, nullPossibleFree text comment about the problem. 
 This field is slated to be deprecated in favor of Comments[].Text
- CommentsArray of objectFree text comments about the problem. - Textstring, nullReliableThe plain text comment. 
 
 
- ReasonForReferralTextstring, nullProbableFree 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.
- ReasonForVisitTextstring, nullProbableFree 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.
- ReasonForVisitArray of objectAn array of all reasons for the visit - Codestring, nullPossibleA code describing the coded reason for this visit 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the coded reason for this visit 
- AltCodesArray of objectAlternate or translation codes for the coded reason for this visit - Codestring, nullPossibleA code describing the coded reason for this visit 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the coded reason for this visit 
 
- Categoryobject- Codestring, nullPossibleA code describing the type of problem this is (complaint, diagnosis, symptom, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of problem this is (complaint, diagnosis, symptom, etc.) 
- AltCodesArray of objectAlternate or translation codes for the type of problem this is (complaint, diagnosis, symptom, etc.) - Codestring, nullPossibleA code describing the type of problem this is (complaint, diagnosis, symptom, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of problem this is (complaint, diagnosis, symptom, etc.) 
 
 
 
- ResultTextstring, nullReliableFree text form of the results summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- ResultsArray of objectArray of test results for the patient. This can include laboratory results, imaging results, and procedure results. - Codestring, nullReliableA code describing the test performed and resulted. 
 LOINC for Lab, SNOMED CT otherwise
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the test performed and resulted. 
- AltCodesArray of objectAlternate or translation codes for the test performed and resulted. - Codestring, nullPossibleA code describing the test performed and resulted. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the test performed and resulted. 
 
- EncounterobjectEncounter associated with this result (if different from the encompassing encounter) - IdentifiersArray of objectList of IDs specific to this encounter - IDstring, nullPossibleAn ID specific to this encounter 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Statusstring, nullPossibleThe status of the encounter 
- Typeobject- Codestring, nullReliableA code describing the type of encounter (office visit, hospital, etc). 
 CPT-4
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the type of encounter (office visit, hospital, etc) 
- AltCodesArray of objectAlternate or translation codes for the type of encounter (office visit, hospital, etc) - Codestring, nullPossibleA code describing the type of encounter (office visit, hospital, etc) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of encounter (office visit, hospital, etc) 
 
 
- DateTimestring, nullReliableWhen the encounter took place, or alternatively when the encounter began if Results[].Encounter.EndDateTime is present. 
 ISO 8601 Format
- EndDateTimestring, nullPossibleWhen the encounter was completed, if available. 
 ISO 8601 Format
 
- Statusstring, nullReliableThe status of the test (In Progress, Final) 
- Producerobject- IDstring, nullPossibleID of the producer for this result. 
 The "Producer" is typically the Lab which did the resulting.
- Namestring, nullPossibleName of the producer 
- IDTypestring, nullPossibleID Type for the corresponding ID of this producer 
- AddressobjectResult producer's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
- Usestring, nullPossibleUse 
 
 
- SpecimenobjectDetails about the target of focused laboratory, radiology or other observations - CollectionDateTimenull, nullPossibleA specific date/time when the specimen was collected 
- IdentifiersArray of stringOne or more unique identifiers for this specimen. Each may be a single OID or UUID, or it may be two values, separated by a ^. 
- Sourceobject- Codestring, nullPossibleA code describing code or name describing the specimen 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of code or name describing the specimen 
 
- TargetSiteobject- Codestring, nullPossibleA code describing code specifying detail about the anatomical site or system that is the focus of the observation 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of code specifying detail about the anatomical site or system that is the focus of the observation 
 
 
- ObservationsArray of objectA list of corresponding observations for the test (result components) - Codestring, nullReliableA code describing the individual result component. . 
 LOINC for Lab, SNOMED CT otherwise
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the individual result component. 
- AltCodesArray of objectAlternate or translation codes for the individual result component. - Codestring, nullPossibleA code describing the individual result component. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the individual result component. 
 
- Statusstring, nullReliableThe status of the individual component. Some tests may have different components finish at different times. . 
 One of (In Progress, Final)
- Interpretationstring, nullProbableA flag indicating whether or not the observed value is normal, high, or low. 
 Supported Values
- DateTimestring, nullReliableA specific date/time when the value was recorded. 
 ISO 8601 Format
- CodedValueobject- Codestring, nullPossibleA code describing the individual result value. 
 Only populated if the result is sent as a coded value. Observations[].CodedValue.Name will be duplicated in Observations[].Value
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the individual result value. 
- AltCodesArray of objectAlternate or translation codes for the individual result value. - Codestring, nullPossibleA code describing the individual result value. 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the individual result value. 
 
 
- Valuestring, nullReliableThe measurement recorded for the result. 
- ValueTypestring, nullReliableThe type and format of the value. 
 One of the following: PhysicalQuantity, String, Number, Interval, Ratio, Code, Encapsulated Data. Intervals will be represented in Value as low-high, <low, <=low, >high, or >=high. Ratios will be represented in Value as numerator:denominator.
- FileTypestring, nullPossibleThe file content type of the encapsulated data. 
 Only available when ValueType is Encapsulated Data
- Unitsstring, nullReliableThe units of the measurement. 
 Only available when ValueType is PhysicalQuantity
- ReferenceRangeobjectReference range for the result. 
 Numeric result values will use the low and high properties. Non-numeric result values will put the normal value in the text property.- Lowstring, nullPossibleLower bound for a normal result 
- Highstring, nullPossibleUpper bound for a normal result 
- Textstring, nullPossibleThe normal value for non-numeric results 
 
- CommentsArray of objectFree text comments about the result. - Textstring, nullReliableThe plain text comment. 
 
 
 
- ReviewOfSystemsTextstring, nullReliableFree text about symptoms and wellbeing of the patient. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- SocialHistoryTextstring, nullProbableFree text form of the social history summary 
- SocialHistoryobject- ObservationsArray of objectGeneric observations about the patient's social history that don't fall into the smoking or pregnancy categories. - Codestring, nullProbableA code describing a type of social history observation (exercise, alcohol intake, etc.) . 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of a type of social history observation (exercise, alcohol intake, etc.) 
- AltCodesArray of objectAlternate or translation codes for a type of social history observation (exercise, alcohol intake, etc.) - Codestring, nullPossibleA code describing a type of social history observation (exercise, alcohol intake, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of a type of social history observation (exercise, alcohol intake, etc.) 
 
- ValueobjectThe observed value - Codestring, nullProbableA code describing the observed value, if coded 
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the observed value, if coded 
- AltCodesArray of objectAlternate or translation codes for the observed value, if coded - Codestring, nullPossibleA code describing the observed value, if coded 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the observed value, if coded 
 
 
- ValueTextstring, nullProbableThe observed value, if un-coded 
- Unitsstring, nullPossibleThe units of the measurement, if the observed value is a quantity. 
 UCUM Units of Measure
- StartDatestring, nullProbableStart date of status 
- EndDatestring, nullProbableDate status ended. If this is null, the status is current. 
- CommentsArray of objectFree text comments about the observation. - Textstring, nullReliableThe plain text comment. 
 
 
- PregnancyArray of objectInformation about past and current pregnancies. - StartDatestring, nullProbableWhen the pregnancy started. 
 ISO 8601 Format
- EndDatestring, nullProbableWhen the pregnancy ended. 
 ISO 8601 Format
- EstimatedDeliverystring, nullProbableEstimate delivery date if pregnancy is still active. 
- CommentsArray of objectFree text comments about the pregnancy. - Textstring, nullReliableThe plain text comment. 
 
 
- TobaccoUseArray of objectContains tobacco use and smoking status observations - Codestring, nullProbableA code describing the use of tobacco (current smoker, never smoker, snuff user, etc.). 
 Contains all values descending from the SNOMED CT® 365980008 tobacco use and exposure - finding hierarchy
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the use of tobacco (current smoker, never smoker, snuff user, etc.) 
- AltCodesArray of objectAlternate or translation codes for the use of tobacco (current smoker, never smoker, snuff user, etc.) - Codestring, nullPossibleA code describing the use of tobacco (current smoker, never smoker, snuff user, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the use of tobacco (current smoker, never smoker, snuff user, etc.) 
 
- IsSmokingStatusboolean, nullProbableIdentifies this tobacco use entry as a smoking status. 
 If true, StartDate is the date the smoking status was observed.
- StartDatestring, nullProbableStart date of status. 
 If IsSmokingStatus is true, this is the date the observation was made.
- EndDatestring, nullProbableDate status ended. If this is null, the status is current. 
- CommentsArray of objectFree text comments about the observation. - Textstring, nullReliableThe plain text comment. 
 
 
 
- SubjectiveTextstring, nullReliableFree 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.
- VitalSignsTextstring, nullProbableFree text form of the vital signs summary. 
 When sent via Redox API, this can ONLY be pushed as plain text without any markup.
- VitalSignsArray of objectAn array of groups of vital signs. - DateTimestring, nullPossibleThe date and time of the group of readings. 
 This field is deprecated since vital readings are not necessarily always grouped by time. Instead, the Observations[].DateTime tells when an individual reading took place.
- ObservationsArray of objectAn array of individual vital sign Observations[]. - Codestring, nullReliableA code describing the type of vital sign being read (height, weight, blood pressure, etc.). 
 LOINC (HITSP Vital Sign Result Type).
- CodeSystemstring, nullReliableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullReliableName of the type of vital sign being read (height, weight, blood pressure, etc.) 
- AltCodesArray of objectAlternate or translation codes for the type of vital sign being read (height, weight, blood pressure, etc.) - Codestring, nullPossibleA code describing the type of vital sign being read (height, weight, blood pressure, etc.) 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the type of vital sign being read (height, weight, blood pressure, etc.) 
 
- Statusstring, nullReliableThe status of the reading (usually completed) 
- Interpretationstring, nullProbableA flag indicating whether or not the observed value is normal, high, or low. 
 Supported Values
- DateTimestring, nullReliableThe date/time when the specific vital sign was recorded. 
 ISO 8601 Format
- Valuestring, nullReliableThe measurement recorded for the vital sign. 
- Unitsstring, nullReliableThe units of the measurement. 
 UCUM Units of Measure
- TargetSiteobject- Codestring, nullProbableA code describing the location on the body where the procedure was performed. 
 SNOMED CT
- CodeSystemstring, nullProbableID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullProbableName of the location on the body where the procedure was performed 
- AltCodesArray of objectAlternate or translation codes for the location on the body where the procedure was performed - Codestring, nullPossibleA code describing the location on the body where the procedure was performed 
- CodeSystemstring, nullPossibleID of the coding system to which the code belongs in OID format. 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- CodeSystemNamestring, nullPossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10). 
 Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
- Namestring, nullPossibleName of the location on the body where the procedure was performed 
 
 
- CommentsArray of objectFree text comments about the vital sign. - Textstring, nullReliableThe plain text comment.