PatientAdmin
PatientAdmin messages are used for many things. They are based off the ADT (Admission/Discharge/Transfer) feed at a health system, but they are used for more than just patient tracking. Registration information is one of the main components of PatientAdmin messages, which contain demographics, guarantor and insurance information. It is the most used real time feed in most health systems.
Data Château stores identifiers, basic demographics, and PCP information from all PatientAdmin messages.
An Arrival message is generated when a patient shows up for their visit or when a patient is admitted to the hospital.
Fields
Meta
Meta.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
E.g. New, Update
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
ReliableName of the source
Meta.Destinations[]Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].IDString
ReliableRequiredID for the patient
Patient.Identifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliablePatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossiblePatient's race.
Supported Values
Patient.Demographics.IsHispanicBoolean
PossibleIndicates if the patient is of hispanic origin.
Patient.Demographics.MaritalStatusString
PossiblePatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Patient.Demographics.Citizenship[]Array of strings
PossiblePatient's nation(s) of citizenship.
*In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
Patient.Demographics.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleCountry
Patient.Notes[]Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstNameString
PossibleFirst name of the contact
Patient.Contacts[].MiddleNameString
PossibleMiddle name of the contact
Patient.Contacts[].LastNameString
PossibleLast name of the contact
Patient.Contacts[].AddressObject
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddressString
PossibleStreet address
Patient.Contacts[].Address.CityString
PossibleCity
Patient.Contacts[].Address.StateString
PossibleState
Patient.Contacts[].Address.ZIPString
PossibleZIP
Patient.Contacts[].Address.CountyString
PossibleCounty
Patient.Contacts[].Address.CountryString
PossibleCountry
Patient.Contacts[].PhoneNumber.HomeString
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.OfficeString
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.MobileString
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatientString
PossiblePersonal relationship to the patient.
e.x. Father, Spouse
Patient.Contacts[].EmailAddresses[]Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Patient.Diagnoses[]Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].CodeString
ProbableCode for the diagnosis
Patient.Diagnoses[].CodesetString
ProbableCode set used to identify the diagnosis.
One of the following: ICD-9, ICD-10, HCPCS, CPT
Patient.Diagnoses[].NameString
ProbableName of the diagnosis
Patient.Diagnoses[].TypeString
PossibleList of diagnoses associated with this visit.
One of the following: Admitting, Working, or Final
Patient.Allergies[]Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].CodeString
PossibleCode for the allergy
Patient.Allergies[].CodesetString
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].NameString
PossibleName of the allergy
Patient.Allergies[].OnsetDateTimeString
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].CodeString
PossibleCode for the reaction
Patient.Allergies[].Reaction[].CodesetString
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].NameString
PossibleName of the reaction
Patient.PCPObject
ReliablePrimary Care Provider for the Patient
Patient.PCP.NPIString
ReliableNPI of the PCP
Patient.PCP.IDString
ReliableID of the PCP.
This ID is often required for Inpatient Visits.
Patient.PCP.IDTypeString
ReliableID type of the ID for the PCP
Patient.PCP.FirstNameString
PossibleFirst name of the PCP
Patient.PCP.LastNameString
PossibleLast name of the PCP
Patient.PCP.Credentials[]Array of Strings
PossibleList of credentials for the PCP.
e.g. MD, PhD
Patient.PCP.AddressObject
PossibleProvider's address
Patient.PCP.Address.StreetAddressString
PossibleStreet address
Patient.PCP.Address.CityString
PossibleCity
Patient.PCP.Address.StateString
PossibleState
Patient.PCP.Address.ZIPString
PossibleZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Patient.PCP.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.PCP.LocationObject
PossibleProvider's location
Patient.PCP.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.PCP.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Patient.PCP.Location.DepartmentString
PossibleDepartment
Patient.PCP.Location.RoomString
PossibleRoom.
Example: 136
Patient.PCP.PhoneNumberString
ProbablePCP's phone number.
In E. 164 Format. (i.e. +16085551234)
Patient.PCP.AddressObject
ProbablePCP's address
Patient.PCP.Address.StreetAddressString
ProbableStreet address
Patient.PCP.Address.CityString
ProbableCity
Patient.PCP.Address.StateString
ProbableState
Patient.PCP.Address.ZIPString
ProbableZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Visit
Visit.VisitNumberString
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumberString
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClassString
ReliableRequiredPatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTimeString
ReliableDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.DurationNumeric
ProbableLength of visit.
In minutes
Visit.ReasonString
ProbableReason for visit
Visit.Instructions[]Array of Strings
ProbableAppointment instructions
Visit.BalanceNumeric
PossiblePatient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.
Visit.AttendingProvider.IDString
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDTypeString
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstNameString
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastNameString
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.AddressObject
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddressString
PossibleStreet address
Visit.AttendingProvider.Address.CityString
PossibleCity
Visit.AttendingProvider.Address.StateString
PossibleState
Visit.AttendingProvider.Address.ZIPString
PossibleZIP
Visit.AttendingProvider.Address.CountyString
PossibleCounty
Visit.AttendingProvider.Address.CountryString
PossibleCountry
Visit.AttendingProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.LocationObject
PossibleProvider's location
Visit.AttendingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.DepartmentString
PossibleDepartment
Visit.AttendingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ConsultingProvider.IDString
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDTypeString
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstNameString
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastNameString
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.AddressObject
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddressString
PossibleStreet address
Visit.ConsultingProvider.Address.CityString
PossibleCity
Visit.ConsultingProvider.Address.StateString
PossibleState
Visit.ConsultingProvider.Address.ZIPString
PossibleZIP
Visit.ConsultingProvider.Address.CountyString
PossibleCounty
Visit.ConsultingProvider.Address.CountryString
PossibleCountry
Visit.ConsultingProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.LocationObject
PossibleProvider's location
Visit.ConsultingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.DepartmentString
PossibleDepartment
Visit.ConsultingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ReferringProvider.IDString
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDTypeString
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstNameString
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastNameString
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.AddressObject
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddressString
PossibleStreet address
Visit.ReferringProvider.Address.CityString
PossibleCity
Visit.ReferringProvider.Address.StateString
PossibleState
Visit.ReferringProvider.Address.ZIPString
PossibleZIP
Visit.ReferringProvider.Address.CountyString
PossibleCounty
Visit.ReferringProvider.Address.CountryString
PossibleCountry
Visit.ReferringProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.LocationObject
PossibleProvider's location
Visit.ReferringProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.DepartmentString
PossibleDepartment
Visit.ReferringProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.LocationObject
ProbableLocation of the appointment
Visit.Location.TypeString
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.FacilityString
ProbableFacility.
Example: Community Hospital
Visit.Location.DepartmentString
ProbableDepartment
Visit.Location.RoomString
ProbableRoom.
Example: 136
Visit.Location.BedString
ProbableBed.
Example: B
Visit.Location.AddressObject
ProbableAddress of the appointment location
Visit.Location.Address.StreetAddressString
ProbableStreet address
Visit.Location.Address.CityString
ProbableCity
Visit.Location.Address.StateString
ProbableState
Visit.Location.Address.ZIPString
ProbableZIP
Visit.Location.Address.CountyString
PossibleCounty
Visit.Location.Address.CountryString
PossibleCountry
Visit.GuarantorObject
PossiblePerson ultimately responsible for the bill of the appointment
Visit.Guarantor.NumberString
ProbableNumber of the guarantor
Visit.Guarantor.FirstNameString
ProbableFirst name
Visit.Guarantor.LastNameString
ProbableLast name
Visit.Guarantor.DOBString
PossibleGuarantor's date of birth.
In ISO 8601 format
Visit.Guarantor.SexString
PossibleGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Spouse.FirstNameString
ProbableSpouse's first name
Visit.Guarantor.Spouse.LastNameString
ProbableSpouse's last name
Visit.Guarantor.AddressObject
ProbableAddress of the guarantor
Visit.Guarantor.Address.StreetAddressString
ProbableStreet address
Visit.Guarantor.Address.CityString
ProbableCity
Visit.Guarantor.Address.StateString
ProbableState
Visit.Guarantor.Address.ZIPString
ProbableZIP
Visit.Guarantor.Address.CountyString
PossibleCounty
Visit.Guarantor.Address.CountryString
PossibleCountry
Visit.Guarantor.PhoneNumber.HomeString
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.BusinessString
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.TypeString
ProbableType of guarantor.
E.g. institution, individual
Visit.Guarantor.RelationToPatientString
ProbableRelation to the patient.
E.g. self, parent
Visit.Guarantor.Employer.NameString
ProbableEmployer's name
Visit.Guarantor.Employer.AddressObject
ProbableEmployer's address
Visit.Guarantor.Employer.Address.StreetAddressString
ProbableStreet address
Visit.Guarantor.Employer.Address.CityString
ProbableCity
Visit.Guarantor.Employer.Address.StateString
ProbableState
Visit.Guarantor.Employer.Address.ZIPString
ProbableZIP
Visit.Guarantor.Employer.Address.CountyString
PossibleCounty
Visit.Guarantor.Employer.Address.CountryString
PossibleCountry
Visit.Guarantor.Employer.PhoneNumberString
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[]Array of Objects
ProbableList of insurance coverages for the patient
Visit.Insurances[].Plan.IDString
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDTypeString
ProbableID type of insurance plan
Visit.Insurances[].Plan.NameString
ProbableName of insurance plan
Visit.Insurances[].Plan.TypeString
PossibleType of insurance plan
Visit.Insurances[].MemberNumberString
PossiblePatient member number
Visit.Insurances[].Company.IDString
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDTypeString
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.NameString
ProbableName of insurance company (payor)
Visit.Insurances[].Company.AddressObject
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddressString
ProbableStreet address
Visit.Insurances[].Company.Address.CityString
ProbableCity
Visit.Insurances[].Company.Address.StateString
ProbableState
Visit.Insurances[].Company.Address.ZIPString
ProbableZIP
Visit.Insurances[].Company.Address.CountyString
PossibleCounty
Visit.Insurances[].Company.Address.CountryString
PossibleCountry
Visit.Insurances[].Company.PhoneNumberString
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumberString
ProbableInsurance policy group number
Visit.Insurances[].GroupNameString
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDateString
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDateString
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumberString
ProbableInsurance policy number
Visit.Insurances[].AgreementTypeString
ProbableType of insurance agreement.
One of the following: "Standard", "Unified", "Maternity"
Visit.Insurances[].CoverageTypeString
ProbableType of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Visit.Insurances[].InsuredObject
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.LastNameString
PossibleLast name of the insured
Visit.Insurances[].Insured.FirstNameString
PossibleFirst name of the insured
Visit.Insurances[].Insured.RelationshipString
PossibleRelationship of the insured to the patient.
One of the following: "Self", "Spouse", "Other".
Visit.Insurances[].Insured.DOBString
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.SexString
PossibleSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.AddressObject
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddressString
ProbableStreet address
Visit.Insurances[].Insured.Address.CityString
ProbableCity
Visit.Insurances[].Insured.Address.StateString
ProbableState
Visit.Insurances[].Insured.Address.ZIPString
ProbableZIP
Visit.Insurances[].Insured.Address.CountyString
PossibleCounty
Visit.Insurances[].Insured.Address.CountryString
PossibleCountry
resourceType
resourceTypeBundle
type
typeCurrently, Redox supports only the 'Message' Type
entry
The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
entry[].fullUrlAbsolute URL for resource.
Ex: server address or UUID/OID.
entry[].resource - MessageHeader
MessageHeader Resource Information
entry[].resource.idLogical id of this artifact
entry[].resource.resourceTypeMessageHeader
entry[].resource.eventCode for the event this message represents
entry[].resource.event.code
entry[].resource.timestampTime that the message was sent
Message source application
entry[].resource.source.nameName of the source system
entry[].resource.source.endpointActual message source address or id
entry[].resource.focusPointers to the actual content of the message
entry[].resource.focus[].referenceReferences to the rest of the bundle
entry[].resource - Patient
entry[].resource.resourceTypePatient
entry[].resource.identifierA list of identifiers for this patient
entry[].resource.identifier[].value
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.birthdateData of birth for the patient
entry[].resource.telecomA contact detail for the patient
entry[].resource.telecom[].value
entry[].resource.telecom[].systemA contact detail for the patient.
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the patient
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
entry[].resource.address[].useThe purpose of the address
A list of names associated with the patient
entry[].resource.name[].familyOften called 'Surname.'
entry[].resource.name[].given[]string[]
Administrative gender for the patient.
The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
entry[].resource.maritalStatusMarital Status of a patient
entry[].resource.maritalStatus.text
entry[].resource.extensionAdditional Content defined by implementations
entry[].resource.extension[].url
entry[].resource.extension[].extension
entry[].resource.extension[].extension[].url
entry[].resource.extension[].extension[].valueString
A list of languages which may be used to communicate with the patient.
entry[].resource.communication[].language
entry[].resource.communication[].language.text
entry[].resource.communication[].language.coding
entry[].resource.communication[].language.coding.codeSymbol defined by the system
entry[].resource.communication[].language.coding.systemIdentity/namespace of the terminology system
entry[].resource.communication[].language.coding.displayDisplay value of the code, as defined by the system
entry[].resource - Practitioner
entry[].resource.resourceTypePractitioner
entry[].resource.activeWhether this practitioner's record is in active use
A list of identifiers that apply to this person in this role
entry[].resource.identifier[].valueUnique value identifier
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.telecomContact information for the practitioner
entry[].resource.telecom[].valueActual contact point details
entry[].resource.telecom[].systemA contact detail for the practitioner (that apply to all roles).
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the practitioner.
Address(es) are not role specific.
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
The purpose of the address
The name(s) associated with the practitioner.
entry[].resource.name[].familyFamily name.
Often called 'Surname.'
entry[].resource.name[].given[]string[]
Given names (not always 'first'). Includes middle names.
Given names appear in the correct order for presenting the name.
Qualifications obtained by training and certification.
entry[].resource.qualification[].codeCoded representation of the qualification.
entry[].resource.qualification[].code.textText representation of the qualification.
entry[].resource.qualification[].code.coding
entry[].resource.qualification[].code.coding.codeSymbol defined by the system
entry[].resource.qualification[].code.coding.systemIdentity/namespace of the terminology system
entry[].resource.qualification[].code.coding.displayDisplay value of the code, as defined by the system
{
"resourceType": "Bundle",
"type": "message",
"entry": [
{
"fullUrl": "urn:uuid:3f328e47-edc0-4e9d-9d72-262f09e980a5",
"resource": {
"id": "transmission-12414",
"resourceType": "MessageHeader",
"event": {
"code": "PatientAdmin-Arrival"
},
"timestamp": "2018-06-19T23:56:22.180Z",
"source": {
"name": "Redox Dev Tools",
"endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
},
"focus": [
{
"reference": "urn:uuid:11cde42f-11c2-425f-8f78-b8811e456858"
},
{
"reference": "urn:uuid:a8ced45f-b24b-4cbe-b496-a87f25ccfaff"
}
]
}
},
{
"fullUrl": "urn:uuid:11cde42f-11c2-425f-8f78-b8811e456858",
"resource": {
"resourceType": "Patient",
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
},
{
"value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
},
{
"value": "a1d4ee8aba494ca",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"name": [
{
"family": "Bixby",
"given": [
"Timothy",
"Paul"
]
}
],
"gender": "male",
"maritalStatus": {
"text": "Married",
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
]
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "text",
"valueString": "White"
}
]
}
],
"communication": [
{
"language": {
"text": "en",
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
]
}
}
],
"generalPractitioner": [
{
"reference": "urn:uuid:a8ced45f-b24b-4cbe-b496-a87f25ccfaff"
}
]
}
},
{
"fullUrl": "urn:uuid:a8ced45f-b24b-4cbe-b496-a87f25ccfaff",
"resource": {
"resourceType": "Practitioner",
"active": true,
"identifier": [
{
"value": "4356789876",
"system": "http://hl7.org/fhir/sid/us-npi"
}
],
"address": [
{
"line": [
"123 Main St."
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53703",
"country": "USA"
}
],
"name": [
{
"family": "Granite",
"given": [
"Pat"
]
}
],
"qualification": [
{
"code": {
"text": "MD",
"coding": [
{
"code": "MD",
"system": "http://hl7.org/fhir/v2/0360/2.7",
"display": "Doctor of Medicine"
}
]
}
}
]
}
}
]
}{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "Arrival",
"EventDateTime": "2018-06-19T23:56:22.180Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"barb.bixby@test.net"
],
"Roles": [
"Emergency Contact"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
]
}
],
"PCP": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": "Inpatient",
"VisitDateTime": "2018-06-19T23:56:23.175Z",
"Duration": 15,
"Reason": "Check up",
"Instructions": [],
"Balance": null,
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "9509 Integration Ln",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "US"
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"LastName": "Bixby",
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null
},
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductable Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"LastName": null,
"FirstName": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}A Cancel message is generated when a PatientAdmin event is canceled. The Meta.CanceledEvent field indicates which type of event the message cancels (e.g. Arrival, Discharge). For example, set Meta.EventType to "Cancel" and Meta.CanceledEvent to "Arrival" to cancel an arrival event.
Fields
Meta
Meta.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
Cancel
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
DateTime of the cancelation
Meta.CanceledEventString
ReliableType of event being canceled.
E.g. Arrival, Discharge, PreAdmit
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
ReliableName of the source
Meta.Destinations[]Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].IDString
ReliableRequiredID for the patient
Patient.Identifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliablePatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossiblePatient's race.
Supported Values
Patient.Demographics.IsHispanicBoolean
PossibleIndicates if the patient is of hispanic origin.
Patient.Demographics.MaritalStatusString
PossiblePatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Patient.Demographics.Citizenship[]Array of strings
PossiblePatient's nation(s) of citizenship.
*In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
Patient.Demographics.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleCountry
Patient.Notes[]Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstNameString
PossibleFirst name of the contact
Patient.Contacts[].MiddleNameString
PossibleMiddle name of the contact
Patient.Contacts[].LastNameString
PossibleLast name of the contact
Patient.Contacts[].AddressObject
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddressString
PossibleStreet address
Patient.Contacts[].Address.CityString
PossibleCity
Patient.Contacts[].Address.StateString
PossibleState
Patient.Contacts[].Address.ZIPString
PossibleZIP
Patient.Contacts[].Address.CountyString
PossibleCounty
Patient.Contacts[].Address.CountryString
PossibleCountry
Patient.Contacts[].PhoneNumber.HomeString
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.OfficeString
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.MobileString
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatientString
PossiblePersonal relationship to the patient.
e.x. Father, Spouse
Patient.Contacts[].EmailAddresses[]Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Patient.Diagnoses[]Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].CodeString
ProbableCode for the diagnosis
Patient.Diagnoses[].CodesetString
ProbableCode set used to identify the diagnosis.
One of the following: ICD-9, ICD-10, HCPCS, CPT
Patient.Diagnoses[].NameString
ProbableName of the diagnosis
Patient.Diagnoses[].TypeString
PossibleList of diagnoses associated with this visit.
One of the following: Admitting, Working, or Final
Patient.Allergies[]Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].CodeString
PossibleCode for the allergy
Patient.Allergies[].CodesetString
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].NameString
PossibleName of the allergy
Patient.Allergies[].OnsetDateTimeString
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].CodeString
PossibleCode for the reaction
Patient.Allergies[].Reaction[].CodesetString
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].NameString
PossibleName of the reaction
Patient.PCPObject
ReliablePrimary Care Provider for the Patient
Patient.PCP.NPIString
ReliableNPI of the PCP
Patient.PCP.IDString
ReliableID of the PCP.
This ID is often required for Inpatient Visits.
Patient.PCP.IDTypeString
ReliableID type of the ID for the PCP
Patient.PCP.FirstNameString
PossibleFirst name of the PCP
Patient.PCP.LastNameString
PossibleLast name of the PCP
Patient.PCP.Credentials[]Array of Strings
PossibleList of credentials for the PCP.
e.g. MD, PhD
Patient.PCP.AddressObject
PossibleProvider's address
Patient.PCP.Address.StreetAddressString
PossibleStreet address
Patient.PCP.Address.CityString
PossibleCity
Patient.PCP.Address.StateString
PossibleState
Patient.PCP.Address.ZIPString
PossibleZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Patient.PCP.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.PCP.LocationObject
PossibleProvider's location
Patient.PCP.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.PCP.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Patient.PCP.Location.DepartmentString
PossibleDepartment
Patient.PCP.Location.RoomString
PossibleRoom.
Example: 136
Patient.PCP.PhoneNumberString
ProbablePCP's phone number.
In E. 164 Format. (i.e. +16085551234)
Patient.PCP.AddressObject
ProbablePCP's address
Patient.PCP.Address.StreetAddressString
ProbableStreet address
Patient.PCP.Address.CityString
ProbableCity
Patient.PCP.Address.StateString
ProbableState
Patient.PCP.Address.ZIPString
ProbableZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Visit
Visit.VisitNumberString
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumberString
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClassString
ReliableRequiredPatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTimeString
ReliableDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.DurationNumeric
ProbableLength of visit.
In minutes
Visit.ReasonString
ProbableReason for visit
Visit.Instructions[]Array of Strings
ProbableAppointment instructions
Visit.BalanceNumeric
PossiblePatient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.
Visit.AttendingProvider.IDString
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDTypeString
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstNameString
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastNameString
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.AddressObject
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddressString
PossibleStreet address
Visit.AttendingProvider.Address.CityString
PossibleCity
Visit.AttendingProvider.Address.StateString
PossibleState
Visit.AttendingProvider.Address.ZIPString
PossibleZIP
Visit.AttendingProvider.Address.CountyString
PossibleCounty
Visit.AttendingProvider.Address.CountryString
PossibleCountry
Visit.AttendingProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.LocationObject
PossibleProvider's location
Visit.AttendingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.DepartmentString
PossibleDepartment
Visit.AttendingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ConsultingProvider.IDString
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDTypeString
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstNameString
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastNameString
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.AddressObject
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddressString
PossibleStreet address
Visit.ConsultingProvider.Address.CityString
PossibleCity
Visit.ConsultingProvider.Address.StateString
PossibleState
Visit.ConsultingProvider.Address.ZIPString
PossibleZIP
Visit.ConsultingProvider.Address.CountyString
PossibleCounty
Visit.ConsultingProvider.Address.CountryString
PossibleCountry
Visit.ConsultingProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.LocationObject
PossibleProvider's location
Visit.ConsultingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.DepartmentString
PossibleDepartment
Visit.ConsultingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ReferringProvider.IDString
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDTypeString
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstNameString
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastNameString
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.AddressObject
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddressString
PossibleStreet address
Visit.ReferringProvider.Address.CityString
PossibleCity
Visit.ReferringProvider.Address.StateString
PossibleState
Visit.ReferringProvider.Address.ZIPString
PossibleZIP
Visit.ReferringProvider.Address.CountyString
PossibleCounty
Visit.ReferringProvider.Address.CountryString
PossibleCountry
Visit.ReferringProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.LocationObject
PossibleProvider's location
Visit.ReferringProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.DepartmentString
PossibleDepartment
Visit.ReferringProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.LocationObject
ProbableLocation of the appointment
Visit.Location.TypeString
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.FacilityString
ProbableFacility.
Example: Community Hospital
Visit.Location.DepartmentString
ProbableDepartment
Visit.Location.RoomString
ProbableRoom.
Example: 136
Visit.Location.BedString
ProbableBed.
Example: B
Visit.Location.AddressObject
ProbableAddress of the appointment location
Visit.Location.Address.StreetAddressString
ProbableStreet address
Visit.Location.Address.CityString
ProbableCity
Visit.Location.Address.StateString
ProbableState
Visit.Location.Address.ZIPString
ProbableZIP
Visit.Location.Address.CountyString
PossibleCounty
Visit.Location.Address.CountryString
PossibleCountry
Visit.GuarantorObject
PossiblePerson ultimately responsible for the bill of the appointment
Visit.Guarantor.NumberString
ProbableNumber of the guarantor
Visit.Guarantor.FirstNameString
ProbableFirst name
Visit.Guarantor.LastNameString
ProbableLast name
Visit.Guarantor.DOBString
PossibleGuarantor's date of birth.
In ISO 8601 format
Visit.Guarantor.SexString
PossibleGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Spouse.FirstNameString
ProbableSpouse's first name
Visit.Guarantor.Spouse.LastNameString
ProbableSpouse's last name
Visit.Guarantor.AddressObject
ProbableAddress of the guarantor
Visit.Guarantor.Address.StreetAddressString
ProbableStreet address
Visit.Guarantor.Address.CityString
ProbableCity
Visit.Guarantor.Address.StateString
ProbableState
Visit.Guarantor.Address.ZIPString
ProbableZIP
Visit.Guarantor.Address.CountyString
PossibleCounty
Visit.Guarantor.Address.CountryString
PossibleCountry
Visit.Guarantor.PhoneNumber.HomeString
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.BusinessString
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.TypeString
ProbableType of guarantor.
E.g. institution, individual
Visit.Guarantor.RelationToPatientString
ProbableRelation to the patient.
E.g. self, parent
Visit.Guarantor.Employer.NameString
ProbableEmployer's name
Visit.Guarantor.Employer.AddressObject
ProbableEmployer's address
Visit.Guarantor.Employer.Address.StreetAddressString
ProbableStreet address
Visit.Guarantor.Employer.Address.CityString
ProbableCity
Visit.Guarantor.Employer.Address.StateString
ProbableState
Visit.Guarantor.Employer.Address.ZIPString
ProbableZIP
Visit.Guarantor.Employer.Address.CountyString
PossibleCounty
Visit.Guarantor.Employer.Address.CountryString
PossibleCountry
Visit.Guarantor.Employer.PhoneNumberString
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[]Array of Objects
ProbableList of insurance coverages for the patient
Visit.Insurances[].Plan.IDString
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDTypeString
ProbableID type of insurance plan
Visit.Insurances[].Plan.NameString
ProbableName of insurance plan
Visit.Insurances[].Plan.TypeString
PossibleType of insurance plan
Visit.Insurances[].MemberNumberString
PossiblePatient member number
Visit.Insurances[].Company.IDString
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDTypeString
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.NameString
ProbableName of insurance company (payor)
Visit.Insurances[].Company.AddressObject
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddressString
ProbableStreet address
Visit.Insurances[].Company.Address.CityString
ProbableCity
Visit.Insurances[].Company.Address.StateString
ProbableState
Visit.Insurances[].Company.Address.ZIPString
ProbableZIP
Visit.Insurances[].Company.Address.CountyString
PossibleCounty
Visit.Insurances[].Company.Address.CountryString
PossibleCountry
Visit.Insurances[].Company.PhoneNumberString
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumberString
ProbableInsurance policy group number
Visit.Insurances[].GroupNameString
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDateString
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDateString
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumberString
ProbableInsurance policy number
Visit.Insurances[].AgreementTypeString
ProbableType of insurance agreement.
One of the following: "Standard", "Unified", "Maternity"
Visit.Insurances[].CoverageTypeString
ProbableType of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Visit.Insurances[].InsuredObject
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.LastNameString
PossibleLast name of the insured
Visit.Insurances[].Insured.FirstNameString
PossibleFirst name of the insured
Visit.Insurances[].Insured.RelationshipString
PossibleRelationship of the insured to the patient.
One of the following: "Self", "Spouse", "Other".
Visit.Insurances[].Insured.DOBString
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.SexString
PossibleSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.AddressObject
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddressString
ProbableStreet address
Visit.Insurances[].Insured.Address.CityString
ProbableCity
Visit.Insurances[].Insured.Address.StateString
ProbableState
Visit.Insurances[].Insured.Address.ZIPString
ProbableZIP
Visit.Insurances[].Insured.Address.CountyString
PossibleCounty
Visit.Insurances[].Insured.Address.CountryString
PossibleCountry
resourceType
resourceTypeBundle
type
typeCurrently, Redox supports only the 'Message' Type
entry
The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
entry[].fullUrlAbsolute URL for resource.
Ex: server address or UUID/OID.
entry[].resource - MessageHeader
MessageHeader Resource Information
entry[].resource.idLogical id of this artifact
entry[].resource.resourceTypeMessageHeader
entry[].resource.eventCode for the event this message represents
entry[].resource.event.code
entry[].resource.timestampTime that the message was sent
Message source application
entry[].resource.source.nameName of the source system
entry[].resource.source.endpointActual message source address or id
entry[].resource.focusPointers to the actual content of the message
entry[].resource.focus[].referenceReferences to the rest of the bundle
entry[].resource - Patient
entry[].resource.resourceTypePatient
entry[].resource.identifierA list of identifiers for this patient
entry[].resource.identifier[].value
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.birthdateData of birth for the patient
entry[].resource.telecomA contact detail for the patient
entry[].resource.telecom[].value
entry[].resource.telecom[].systemA contact detail for the patient.
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the patient
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
entry[].resource.address[].useThe purpose of the address
A list of names associated with the patient
entry[].resource.name[].familyOften called 'Surname.'
entry[].resource.name[].given[]string[]
Administrative gender for the patient.
The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
entry[].resource.maritalStatusMarital Status of a patient
entry[].resource.maritalStatus.text
entry[].resource.extensionAdditional Content defined by implementations
entry[].resource.extension[].url
entry[].resource.extension[].extension
entry[].resource.extension[].extension[].url
entry[].resource.extension[].extension[].valueString
A list of languages which may be used to communicate with the patient.
entry[].resource.communication[].language
entry[].resource.communication[].language.text
entry[].resource.communication[].language.coding
entry[].resource.communication[].language.coding.codeSymbol defined by the system
entry[].resource.communication[].language.coding.systemIdentity/namespace of the terminology system
entry[].resource.communication[].language.coding.displayDisplay value of the code, as defined by the system
entry[].resource - Practitioner
entry[].resource.resourceTypePractitioner
entry[].resource.activeWhether this practitioner's record is in active use
A list of identifiers that apply to this person in this role
entry[].resource.identifier[].valueUnique value identifier
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.telecomContact information for the practitioner
entry[].resource.telecom[].valueActual contact point details
entry[].resource.telecom[].systemA contact detail for the practitioner (that apply to all roles).
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the practitioner.
Address(es) are not role specific.
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
The purpose of the address
The name(s) associated with the practitioner.
entry[].resource.name[].familyFamily name.
Often called 'Surname.'
entry[].resource.name[].given[]string[]
Given names (not always 'first'). Includes middle names.
Given names appear in the correct order for presenting the name.
Qualifications obtained by training and certification.
entry[].resource.qualification[].codeCoded representation of the qualification.
entry[].resource.qualification[].code.textText representation of the qualification.
entry[].resource.qualification[].code.coding
entry[].resource.qualification[].code.coding.codeSymbol defined by the system
entry[].resource.qualification[].code.coding.systemIdentity/namespace of the terminology system
entry[].resource.qualification[].code.coding.displayDisplay value of the code, as defined by the system
{
"resourceType": "Bundle",
"type": "message",
"entry": [
{
"fullUrl": "urn:uuid:aaec53ff-48d6-4a43-b709-e75de3cc2fb3",
"resource": {
"id": "transmission-12414",
"resourceType": "MessageHeader",
"event": {
"code": "PatientAdmin-Cancel"
},
"timestamp": "2018-06-19T23:56:22.180Z",
"source": {
"name": "Redox Dev Tools",
"endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
},
"focus": [
{
"reference": "urn:uuid:1452e45f-bff0-40d5-84e0-8f731a41cb0c"
},
{
"reference": "urn:uuid:89ec2c41-ae03-40cc-abf3-8f43cd1ad475"
}
]
}
},
{
"fullUrl": "urn:uuid:1452e45f-bff0-40d5-84e0-8f731a41cb0c",
"resource": {
"resourceType": "Patient",
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
},
{
"value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
},
{
"value": "a1d4ee8aba494ca",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"name": [
{
"family": "Bixby",
"given": [
"Timothy",
"Paul"
]
}
],
"gender": "male",
"maritalStatus": {
"text": "Married",
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
]
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "text",
"valueString": "White"
}
]
}
],
"communication": [
{
"language": {
"text": "en",
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
]
}
}
],
"generalPractitioner": [
{
"reference": "urn:uuid:89ec2c41-ae03-40cc-abf3-8f43cd1ad475"
}
]
}
},
{
"fullUrl": "urn:uuid:89ec2c41-ae03-40cc-abf3-8f43cd1ad475",
"resource": {
"resourceType": "Practitioner",
"active": true,
"identifier": [
{
"value": "4356789876",
"system": "http://hl7.org/fhir/sid/us-npi"
}
],
"address": [
{
"line": [
"123 Main St."
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53703",
"country": "USA"
}
],
"name": [
{
"family": "Granite",
"given": [
"Pat"
]
}
],
"qualification": [
{
"code": {
"text": "MD",
"coding": [
{
"code": "MD",
"system": "http://hl7.org/fhir/v2/0360/2.7",
"display": "Doctor of Medicine"
}
]
}
}
]
}
}
]
}{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "Cancel",
"EventDateTime": "2018-06-19T23:56:22.180Z",
"CanceledEvent": "Arrival",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"barb.bixby@test.net"
],
"Roles": [
"Emergency Contact"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
]
}
],
"PCP": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": "Inpatient",
"VisitDateTime": "2018-06-19T23:56:23.195Z",
"Duration": 15,
"Reason": "Check up",
"Instructions": [],
"Balance": null,
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "9509 Integration Ln",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "US"
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"LastName": "Bixby",
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null
},
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductable Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"LastName": null,
"FirstName": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}A Discharge message is generated when a patient is discharged or checked out from a clinical stay or visit.
Fields
Meta
Meta.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
Discharge
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
ReliableName of the source
Meta.Destinations[]Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].IDString
ReliableRequiredID for the patient
Patient.Identifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliablePatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossiblePatient's race.
Supported Values
Patient.Demographics.IsHispanicBoolean
PossibleIndicates if the patient is of hispanic origin.
Patient.Demographics.MaritalStatusString
PossiblePatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Patient.Demographics.Citizenship[]Array of strings
PossiblePatient's nation(s) of citizenship.
*In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
Patient.Demographics.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleCountry
Patient.Notes[]Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstNameString
PossibleFirst name of the contact
Patient.Contacts[].MiddleNameString
PossibleMiddle name of the contact
Patient.Contacts[].LastNameString
PossibleLast name of the contact
Patient.Contacts[].AddressObject
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddressString
PossibleStreet address
Patient.Contacts[].Address.CityString
PossibleCity
Patient.Contacts[].Address.StateString
PossibleState
Patient.Contacts[].Address.ZIPString
PossibleZIP
Patient.Contacts[].Address.CountyString
PossibleCounty
Patient.Contacts[].Address.CountryString
PossibleCountry
Patient.Contacts[].PhoneNumber.HomeString
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.OfficeString
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.MobileString
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatientString
PossiblePersonal relationship to the patient.
e.x. Father, Spouse
Patient.Contacts[].EmailAddresses[]Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Patient.Diagnoses[]Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].CodeString
ProbableCode for the diagnosis
Patient.Diagnoses[].CodesetString
ProbableCode set used to identify the diagnosis.
One of the following: ICD-9, ICD-10, HCPCS, CPT
Patient.Diagnoses[].NameString
ProbableName of the diagnosis
Patient.Diagnoses[].TypeString
PossibleList of diagnoses associated with this visit.
One of the following: Admitting, Working, or Final
Patient.Allergies[]Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].CodeString
PossibleCode for the allergy
Patient.Allergies[].CodesetString
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].NameString
PossibleName of the allergy
Patient.Allergies[].OnsetDateTimeString
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].CodeString
PossibleCode for the reaction
Patient.Allergies[].Reaction[].CodesetString
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].NameString
PossibleName of the reaction
Patient.PCPObject
ReliablePrimary Care Provider for the Patient
Patient.PCP.NPIString
ReliableNPI of the PCP
Patient.PCP.IDString
ReliableID of the PCP.
This ID is often required for Inpatient Visits.
Patient.PCP.IDTypeString
ReliableID type of the ID for the PCP
Patient.PCP.FirstNameString
PossibleFirst name of the PCP
Patient.PCP.LastNameString
PossibleLast name of the PCP
Patient.PCP.Credentials[]Array of Strings
PossibleList of credentials for the PCP.
e.g. MD, PhD
Patient.PCP.AddressObject
PossibleProvider's address
Patient.PCP.Address.StreetAddressString
PossibleStreet address
Patient.PCP.Address.CityString
PossibleCity
Patient.PCP.Address.StateString
PossibleState
Patient.PCP.Address.ZIPString
PossibleZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Patient.PCP.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.PCP.LocationObject
PossibleProvider's location
Patient.PCP.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.PCP.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Patient.PCP.Location.DepartmentString
PossibleDepartment
Patient.PCP.Location.RoomString
PossibleRoom.
Example: 136
Patient.PCP.PhoneNumberString
ProbablePCP's phone number.
In E. 164 Format. (i.e. +16085551234)
Patient.PCP.AddressObject
ProbablePCP's address
Patient.PCP.Address.StreetAddressString
ProbableStreet address
Patient.PCP.Address.CityString
ProbableCity
Patient.PCP.Address.StateString
ProbableState
Patient.PCP.Address.ZIPString
ProbableZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Visit
Visit.VisitNumberString
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumberString
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClassString
ReliableRequiredPatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTimeString
ReliableDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.DischargeDateTimeString
ReliableDateTime of Patient Discharge.
ISO 8601 Format
Visit.DischargeStatusObject
ProbableA code indicating the disposition or status of the patient at the end of the visit.
Visit.DischargeStatus.CodeString
ProbableCode for the discharge status
Visit.DischargeStatus.CodesetString
ProbableCode set used to identify the discharge status.
Coded using the UB04 FL17 codes
Visit.DischargeStatus.DescriptionString
ProbableDescription of the discharge status
Visit.DischargeLocationObject
ProbableLocation to which the patient was discharged.
Visit.DischargeLocation.TypeString
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.DischargeLocation.FacilityString
ProbableFacility.
Example: Community Hospital
Visit.DischargeLocation.DepartmentString
ProbableDepartment
Visit.DischargeLocation.RoomString
ProbableRoom.
Example: 136
Visit.DurationNumeric
ProbableLength of visit.
In minutes
Visit.ReasonString
ProbableReason for visit
Visit.Instructions[]Array of Strings
ProbableAppointment instructions
Visit.BalanceNumeric
PossiblePatient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.
Visit.AttendingProvider.IDString
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDTypeString
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstNameString
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastNameString
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.AddressObject
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddressString
PossibleStreet address
Visit.AttendingProvider.Address.CityString
PossibleCity
Visit.AttendingProvider.Address.StateString
PossibleState
Visit.AttendingProvider.Address.ZIPString
PossibleZIP
Visit.AttendingProvider.Address.CountyString
PossibleCounty
Visit.AttendingProvider.Address.CountryString
PossibleCountry
Visit.AttendingProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.LocationObject
PossibleProvider's location
Visit.AttendingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.DepartmentString
PossibleDepartment
Visit.AttendingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ConsultingProvider.IDString
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDTypeString
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstNameString
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastNameString
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.AddressObject
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddressString
PossibleStreet address
Visit.ConsultingProvider.Address.CityString
PossibleCity
Visit.ConsultingProvider.Address.StateString
PossibleState
Visit.ConsultingProvider.Address.ZIPString
PossibleZIP
Visit.ConsultingProvider.Address.CountyString
PossibleCounty
Visit.ConsultingProvider.Address.CountryString
PossibleCountry
Visit.ConsultingProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.LocationObject
PossibleProvider's location
Visit.ConsultingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.DepartmentString
PossibleDepartment
Visit.ConsultingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ReferringProvider.IDString
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDTypeString
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstNameString
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastNameString
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.AddressObject
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddressString
PossibleStreet address
Visit.ReferringProvider.Address.CityString
PossibleCity
Visit.ReferringProvider.Address.StateString
PossibleState
Visit.ReferringProvider.Address.ZIPString
PossibleZIP
Visit.ReferringProvider.Address.CountyString
PossibleCounty
Visit.ReferringProvider.Address.CountryString
PossibleCountry
Visit.ReferringProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.LocationObject
PossibleProvider's location
Visit.ReferringProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.DepartmentString
PossibleDepartment
Visit.ReferringProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.LocationObject
ProbableLocation of the appointment
Visit.Location.TypeString
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.FacilityString
ProbableFacility.
Example: Community Hospital
Visit.Location.DepartmentString
ProbableDepartment
Visit.Location.RoomString
ProbableRoom.
Example: 136
Visit.Location.BedString
ProbableBed.
Example: B
Visit.Location.AddressObject
ProbableAddress of the appointment location
Visit.Location.Address.StreetAddressString
ProbableStreet address
Visit.Location.Address.CityString
ProbableCity
Visit.Location.Address.StateString
ProbableState
Visit.Location.Address.ZIPString
ProbableZIP
Visit.Location.Address.CountyString
PossibleCounty
Visit.Location.Address.CountryString
PossibleCountry
Visit.GuarantorObject
PossiblePerson ultimately responsible for the bill of the appointment
Visit.Guarantor.NumberString
ProbableNumber of the guarantor
Visit.Guarantor.FirstNameString
ProbableFirst name
Visit.Guarantor.LastNameString
ProbableLast name
Visit.Guarantor.DOBString
PossibleGuarantor's date of birth.
In ISO 8601 format
Visit.Guarantor.SexString
PossibleGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Spouse.FirstNameString
ProbableSpouse's first name
Visit.Guarantor.Spouse.LastNameString
ProbableSpouse's last name
Visit.Guarantor.AddressObject
ProbableAddress of the guarantor
Visit.Guarantor.Address.StreetAddressString
ProbableStreet address
Visit.Guarantor.Address.CityString
ProbableCity
Visit.Guarantor.Address.StateString
ProbableState
Visit.Guarantor.Address.ZIPString
ProbableZIP
Visit.Guarantor.Address.CountyString
PossibleCounty
Visit.Guarantor.Address.CountryString
PossibleCountry
Visit.Guarantor.PhoneNumber.HomeString
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.BusinessString
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.TypeString
ProbableType of guarantor.
E.g. institution, individual
Visit.Guarantor.RelationToPatientString
ProbableRelation to the patient.
E.g. self, parent
Visit.Guarantor.Employer.NameString
ProbableEmployer's name
Visit.Guarantor.Employer.AddressObject
ProbableEmployer's address
Visit.Guarantor.Employer.Address.StreetAddressString
ProbableStreet address
Visit.Guarantor.Employer.Address.CityString
ProbableCity
Visit.Guarantor.Employer.Address.StateString
ProbableState
Visit.Guarantor.Employer.Address.ZIPString
ProbableZIP
Visit.Guarantor.Employer.Address.CountyString
PossibleCounty
Visit.Guarantor.Employer.Address.CountryString
PossibleCountry
Visit.Guarantor.Employer.PhoneNumberString
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[]Array of Objects
ProbableList of insurance coverages for the patient
Visit.Insurances[].Plan.IDString
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDTypeString
ProbableID type of insurance plan
Visit.Insurances[].Plan.NameString
ProbableName of insurance plan
Visit.Insurances[].Plan.TypeString
PossibleType of insurance plan
Visit.Insurances[].MemberNumberString
PossiblePatient member number
Visit.Insurances[].Company.IDString
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDTypeString
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.NameString
ProbableName of insurance company (payor)
Visit.Insurances[].Company.AddressObject
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddressString
ProbableStreet address
Visit.Insurances[].Company.Address.CityString
ProbableCity
Visit.Insurances[].Company.Address.StateString
ProbableState
Visit.Insurances[].Company.Address.ZIPString
ProbableZIP
Visit.Insurances[].Company.Address.CountyString
PossibleCounty
Visit.Insurances[].Company.Address.CountryString
PossibleCountry
Visit.Insurances[].Company.PhoneNumberString
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumberString
ProbableInsurance policy group number
Visit.Insurances[].GroupNameString
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDateString
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDateString
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumberString
ProbableInsurance policy number
Visit.Insurances[].AgreementTypeString
ProbableType of insurance agreement.
One of the following: "Standard", "Unified", "Maternity"
Visit.Insurances[].CoverageTypeString
ProbableType of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Visit.Insurances[].InsuredObject
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.LastNameString
PossibleLast name of the insured
Visit.Insurances[].Insured.FirstNameString
PossibleFirst name of the insured
Visit.Insurances[].Insured.RelationshipString
PossibleRelationship of the insured to the patient.
One of the following: "Self", "Spouse", "Other".
Visit.Insurances[].Insured.DOBString
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.SexString
PossibleSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.AddressObject
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddressString
ProbableStreet address
Visit.Insurances[].Insured.Address.CityString
ProbableCity
Visit.Insurances[].Insured.Address.StateString
ProbableState
Visit.Insurances[].Insured.Address.ZIPString
ProbableZIP
Visit.Insurances[].Insured.Address.CountyString
PossibleCounty
Visit.Insurances[].Insured.Address.CountryString
PossibleCountry
resourceType
resourceTypeBundle
type
typeCurrently, Redox supports only the 'Message' Type
entry
The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
entry[].fullUrlAbsolute URL for resource.
Ex: server address or UUID/OID.
entry[].resource - MessageHeader
MessageHeader Resource Information
entry[].resource.idLogical id of this artifact
entry[].resource.resourceTypeMessageHeader
entry[].resource.eventCode for the event this message represents
entry[].resource.event.code
entry[].resource.timestampTime that the message was sent
Message source application
entry[].resource.source.nameName of the source system
entry[].resource.source.endpointActual message source address or id
entry[].resource.focusPointers to the actual content of the message
entry[].resource.focus[].referenceReferences to the rest of the bundle
entry[].resource - Patient
entry[].resource.resourceTypePatient
entry[].resource.identifierA list of identifiers for this patient
entry[].resource.identifier[].value
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.birthdateData of birth for the patient
entry[].resource.telecomA contact detail for the patient
entry[].resource.telecom[].value
entry[].resource.telecom[].systemA contact detail for the patient.
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the patient
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
entry[].resource.address[].useThe purpose of the address
A list of names associated with the patient
entry[].resource.name[].familyOften called 'Surname.'
entry[].resource.name[].given[]string[]
Administrative gender for the patient.
The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
entry[].resource.maritalStatusMarital Status of a patient
entry[].resource.maritalStatus.text
entry[].resource.extensionAdditional Content defined by implementations
entry[].resource.extension[].url
entry[].resource.extension[].extension
entry[].resource.extension[].extension[].url
entry[].resource.extension[].extension[].valueString
A list of languages which may be used to communicate with the patient.
entry[].resource.communication[].language
entry[].resource.communication[].language.text
entry[].resource.communication[].language.coding
entry[].resource.communication[].language.coding.codeSymbol defined by the system
entry[].resource.communication[].language.coding.systemIdentity/namespace of the terminology system
entry[].resource.communication[].language.coding.displayDisplay value of the code, as defined by the system
entry[].resource - Practitioner
entry[].resource.resourceTypePractitioner
entry[].resource.activeWhether this practitioner's record is in active use
A list of identifiers that apply to this person in this role
entry[].resource.identifier[].valueUnique value identifier
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.telecomContact information for the practitioner
entry[].resource.telecom[].valueActual contact point details
entry[].resource.telecom[].systemA contact detail for the practitioner (that apply to all roles).
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the practitioner.
Address(es) are not role specific.
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
The purpose of the address
The name(s) associated with the practitioner.
entry[].resource.name[].familyFamily name.
Often called 'Surname.'
entry[].resource.name[].given[]string[]
Given names (not always 'first'). Includes middle names.
Given names appear in the correct order for presenting the name.
Qualifications obtained by training and certification.
entry[].resource.qualification[].codeCoded representation of the qualification.
entry[].resource.qualification[].code.textText representation of the qualification.
entry[].resource.qualification[].code.coding
entry[].resource.qualification[].code.coding.codeSymbol defined by the system
entry[].resource.qualification[].code.coding.systemIdentity/namespace of the terminology system
entry[].resource.qualification[].code.coding.displayDisplay value of the code, as defined by the system
{
"resourceType": "Bundle",
"type": "message",
"entry": [
{
"fullUrl": "urn:uuid:9c9097da-043b-4821-8718-3d6016d9fadc",
"resource": {
"id": "transmission-12414",
"resourceType": "MessageHeader",
"event": {
"code": "PatientAdmin-Discharge"
},
"timestamp": "2018-06-19T23:56:22.180Z",
"source": {
"name": "Redox Dev Tools",
"endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
},
"focus": [
{
"reference": "urn:uuid:992cf18b-bc52-4b4e-809a-c0bbfc439aa9"
},
{
"reference": "urn:uuid:9ec34579-367a-46e8-994e-6616ea861b81"
}
]
}
},
{
"fullUrl": "urn:uuid:992cf18b-bc52-4b4e-809a-c0bbfc439aa9",
"resource": {
"resourceType": "Patient",
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
},
{
"value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
},
{
"value": "a1d4ee8aba494ca",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"name": [
{
"family": "Bixby",
"given": [
"Timothy",
"Paul"
]
}
],
"gender": "male",
"maritalStatus": {
"text": "Married",
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
]
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "text",
"valueString": "White"
}
]
}
],
"communication": [
{
"language": {
"text": "en",
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
]
}
}
],
"generalPractitioner": [
{
"reference": "urn:uuid:9ec34579-367a-46e8-994e-6616ea861b81"
}
]
}
},
{
"fullUrl": "urn:uuid:9ec34579-367a-46e8-994e-6616ea861b81",
"resource": {
"resourceType": "Practitioner",
"active": true,
"identifier": [
{
"value": "4356789876",
"system": "http://hl7.org/fhir/sid/us-npi"
}
],
"address": [
{
"line": [
"123 Main St."
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53703",
"country": "USA"
}
],
"name": [
{
"family": "Granite",
"given": [
"Pat"
]
}
],
"qualification": [
{
"code": {
"text": "MD",
"coding": [
{
"code": "MD",
"system": "http://hl7.org/fhir/v2/0360/2.7",
"display": "Doctor of Medicine"
}
]
}
}
]
}
}
]
}{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "Discharge",
"EventDateTime": "2018-06-19T23:56:22.180Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"barb.bixby@test.net"
],
"Roles": [
"Emergency Contact"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
]
}
],
"PCP": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": "Inpatient",
"VisitDateTime": "2018-06-18T23:56:23.214Z",
"DischargeDateTime": "2018-06-19T23:56:23.214Z",
"DischargeStatus": {
"Code": "01",
"Codeset": "UB04FL17",
"Description": "Discharged to home care or self care (routine discharge)"
},
"DischargeLocation": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
},
"Duration": null,
"Reason": "Discharged to home",
"Instructions": [],
"Balance": null,
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "9509 Integration Ln",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "US"
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"LastName": "Bixby",
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null
},
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductable Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"LastName": null,
"FirstName": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}The NewPatient event signals that a new patient has been created in the source system. Typically this will be followed with a more specific message such as a VisitUpdate message when a visit is created.
Fields
Meta
Meta.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
E.g. New, Update
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
ReliableName of the source
Meta.Destinations[]Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].IDString
ReliableRequiredID for the patient
Patient.Identifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliablePatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossiblePatient's race.
Supported Values
Patient.Demographics.IsHispanicBoolean
PossibleIndicates if the patient is of hispanic origin.
Patient.Demographics.MaritalStatusString
PossiblePatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Patient.Demographics.Citizenship[]Array of strings
PossiblePatient's nation(s) of citizenship.
*In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
Patient.Demographics.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleCountry
Patient.Notes[]Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstNameString
PossibleFirst name of the contact
Patient.Contacts[].MiddleNameString
PossibleMiddle name of the contact
Patient.Contacts[].LastNameString
PossibleLast name of the contact
Patient.Contacts[].AddressObject
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddressString
PossibleStreet address
Patient.Contacts[].Address.CityString
PossibleCity
Patient.Contacts[].Address.StateString
PossibleState
Patient.Contacts[].Address.ZIPString
PossibleZIP
Patient.Contacts[].Address.CountyString
PossibleCounty
Patient.Contacts[].Address.CountryString
PossibleCountry
Patient.Contacts[].PhoneNumber.HomeString
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.OfficeString
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.MobileString
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatientString
PossiblePersonal relationship to the patient.
e.x. Father, Spouse
Patient.Contacts[].EmailAddresses[]Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Patient.Allergies[]Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].CodeString
PossibleCode for the allergy
Patient.Allergies[].CodesetString
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].NameString
PossibleName of the allergy
Patient.Allergies[].OnsetDateTimeString
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].CodeString
PossibleCode for the reaction
Patient.Allergies[].Reaction[].CodesetString
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].NameString
PossibleName of the reaction
Patient.PCPObject
ReliablePrimary Care Provider for the Patient
Patient.PCPObject
ReliablePrimary Care Provider for the Patient
Patient.PCP.NPIString
ReliableNPI of the PCP
Patient.PCP.IDString
ReliableID of the PCP.
This ID is often required for Inpatient Visits.
Patient.PCP.IDTypeString
ReliableID type of the ID for the PCP
Patient.PCP.FirstNameString
PossibleFirst name of the PCP
Patient.PCP.LastNameString
PossibleLast name of the PCP
Patient.PCP.Credentials[]Array of Strings
PossibleList of credentials for the PCP.
e.g. MD, PhD
Patient.PCP.AddressObject
PossibleProvider's address
Patient.PCP.Address.StreetAddressString
PossibleStreet address
Patient.PCP.Address.CityString
PossibleCity
Patient.PCP.Address.StateString
PossibleState
Patient.PCP.Address.ZIPString
PossibleZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Patient.PCP.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.PCP.LocationObject
PossibleProvider's location
Patient.PCP.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.PCP.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Patient.PCP.Location.DepartmentString
PossibleDepartment
Patient.PCP.Location.RoomString
PossibleRoom.
Example: 136
Patient.GuarantorObject
PossiblePerson ultimately responsible for the bill of the appointment
Patient.Guarantor.NumberString
ProbableNumber of the guarantor
Patient.Guarantor.FirstNameString
ProbableFirst name
Patient.Guarantor.LastNameString
ProbableLast name
Patient.Guarantor.DOBString
PossibleGuarantor's date of birth.
In ISO 8601 format
Patient.Guarantor.SexString
PossibleGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.Spouse.FirstNameString
ProbableSpouse's first name
Patient.Guarantor.Spouse.LastNameString
ProbableSpouse's last name
Patient.Guarantor.AddressObject
ProbableAddress of the guarantor
Patient.Guarantor.Address.StreetAddressString
ProbableStreet address
Patient.Guarantor.Address.CityString
ProbableCity
Patient.Guarantor.Address.StateString
ProbableState
Patient.Guarantor.Address.ZIPString
ProbableZIP
Patient.Guarantor.Address.CountyString
PossibleCounty
Patient.Guarantor.Address.CountryString
PossibleCountry
Patient.Guarantor.PhoneNumber.HomeString
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.PhoneNumber.BusinessString
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.TypeString
ProbableType of guarantor.
E.g. institution, individual
Patient.Guarantor.RelationToPatientString
ProbableRelation to the patient.
E.g. self, parent
Patient.Guarantor.Employer.NameString
ProbableEmployer's name
Patient.Guarantor.Employer.AddressObject
ProbableEmployer's address
Patient.Guarantor.Employer.Address.StreetAddressString
ProbableStreet address
Patient.Guarantor.Employer.Address.CityString
ProbableCity
Patient.Guarantor.Employer.Address.StateString
ProbableState
Patient.Guarantor.Employer.Address.ZIPString
ProbableZIP
Patient.Guarantor.Employer.Address.CountyString
PossibleCounty
Patient.Guarantor.Employer.Address.CountryString
PossibleCountry
Patient.Guarantor.Employer.PhoneNumberString
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Insurances[]Array of Objects
ProbableList of insurance coverages for the patient
Patient.Insurances[].Plan.IDString
ProbableIdentifier of insurance plan
Patient.Insurances[].Plan.IDTypeString
ProbableID type of insurance plan
Patient.Insurances[].Plan.NameString
ProbableName of insurance plan
Patient.Insurances[].Plan.TypeString
PossibleType of insurance plan
Patient.Insurances[].MemberNumberString
PossiblePatient member number
Patient.Insurances[].Company.IDString
ProbableID of insurance company (payor)
Patient.Insurances[].Company.IDTypeString
ProbableID type of insurance company (payor)
Patient.Insurances[].Company.NameString
ProbableName of insurance company (payor)
Patient.Insurances[].Company.AddressObject
ProbableInsurance company's address
Patient.Insurances[].Company.Address.StreetAddressString
ProbableStreet address
Patient.Insurances[].Company.Address.CityString
ProbableCity
Patient.Insurances[].Company.Address.StateString
ProbableState
Patient.Insurances[].Company.Address.ZIPString
ProbableZIP
Patient.Insurances[].Company.Address.CountyString
PossibleCounty
Patient.Insurances[].Company.Address.CountryString
PossibleCountry
Patient.Insurances[].Company.PhoneNumberString
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Insurances[].GroupNumberString
ProbableInsurance policy group number
Patient.Insurances[].GroupNameString
ProbableInsurance policy group name
Patient.Insurances[].EffectiveDateString
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Patient.Insurances[].ExpirationDateString
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Patient.Insurances[].PolicyNumberString
ProbableInsurance policy number
Patient.Insurances[].AgreementTypeString
ProbableType of insurance agreement.
One of the following: "Standard", "Unified", "Maternity"
Patient.Insurances[].CoverageTypeString
ProbableType of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Patient.Insurances[].InsuredObject
PossibleIndividual who has the agreement with the insurance company for the related policy
Patient.Insurances[].Insured.LastNameString
PossibleLast name of the insured
Patient.Insurances[].Insured.FirstNameString
PossibleFirst name of the insured
Patient.Insurances[].Insured.RelationshipString
PossibleRelationship of the insured to the patient.
One of the following: "Self", "Spouse", "Other".
Patient.Insurances[].Insured.DOBString
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Patient.Insurances[].Insured.SexString
PossibleSex of the insured
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Insured.AddressObject
ProbableAddress of the insured
Patient.Insurances[].Insured.Address.StreetAddressString
ProbableStreet address
Patient.Insurances[].Insured.Address.CityString
ProbableCity
Patient.Insurances[].Insured.Address.StateString
ProbableState
Patient.Insurances[].Insured.Address.ZIPString
ProbableZIP
Patient.Insurances[].Insured.Address.CountyString
PossibleCounty
Patient.Insurances[].Insured.Address.CountryString
PossibleCountry
resourceType
resourceTypeBundle
type
typeCurrently, Redox supports only the 'Message' Type
entry
The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
entry[].fullUrlAbsolute URL for resource.
Ex: server address or UUID/OID.
entry[].resource - MessageHeader
MessageHeader Resource Information
entry[].resource.idLogical id of this artifact
entry[].resource.resourceTypeMessageHeader
entry[].resource.eventCode for the event this message represents
entry[].resource.event.code
entry[].resource.timestampTime that the message was sent
Message source application
entry[].resource.source.nameName of the source system
entry[].resource.source.endpointActual message source address or id
entry[].resource.focusPointers to the actual content of the message
entry[].resource.focus[].referenceReferences to the rest of the bundle
entry[].resource - Patient
entry[].resource.resourceTypePatient
entry[].resource.identifierA list of identifiers for this patient
entry[].resource.identifier[].value
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.birthdateData of birth for the patient
entry[].resource.telecomA contact detail for the patient
entry[].resource.telecom[].value
entry[].resource.telecom[].systemA contact detail for the patient.
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the patient
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
entry[].resource.address[].useThe purpose of the address
A list of names associated with the patient
entry[].resource.name[].familyOften called 'Surname.'
entry[].resource.name[].given[]string[]
Administrative gender for the patient.
The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
entry[].resource.maritalStatusMarital Status of a patient
entry[].resource.maritalStatus.text
entry[].resource.extensionAdditional Content defined by implementations
entry[].resource.extension[].url
entry[].resource.extension[].extension
entry[].resource.extension[].extension[].url
entry[].resource.extension[].extension[].valueString
A list of languages which may be used to communicate with the patient.
entry[].resource.communication[].language
entry[].resource.communication[].language.text
entry[].resource.communication[].language.coding
entry[].resource.communication[].language.coding.codeSymbol defined by the system
entry[].resource.communication[].language.coding.systemIdentity/namespace of the terminology system
entry[].resource.communication[].language.coding.displayDisplay value of the code, as defined by the system
entry[].resource - Practitioner
entry[].resource.resourceTypePractitioner
entry[].resource.activeWhether this practitioner's record is in active use
A list of identifiers that apply to this person in this role
entry[].resource.identifier[].valueUnique value identifier
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.telecomContact information for the practitioner
entry[].resource.telecom[].valueActual contact point details
entry[].resource.telecom[].systemA contact detail for the practitioner (that apply to all roles).
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the practitioner.
Address(es) are not role specific.
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
The purpose of the address
The name(s) associated with the practitioner.
entry[].resource.name[].familyFamily name.
Often called 'Surname.'
entry[].resource.name[].given[]string[]
Given names (not always 'first'). Includes middle names.
Given names appear in the correct order for presenting the name.
Qualifications obtained by training and certification.
entry[].resource.qualification[].codeCoded representation of the qualification.
entry[].resource.qualification[].code.textText representation of the qualification.
entry[].resource.qualification[].code.coding
entry[].resource.qualification[].code.coding.codeSymbol defined by the system
entry[].resource.qualification[].code.coding.systemIdentity/namespace of the terminology system
entry[].resource.qualification[].code.coding.displayDisplay value of the code, as defined by the system
entry[].resource - Coverage
entry[].resource.resourceTypeCoverage
entry[].resource.identifierA list of identifiers for this coverage
entry[].resource.identifier[].value
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.statusactive | cancelled | draft | entered-in-error
Additional coverage classifications
entry[].resource.grouping.groupAn identifier for the group
entry[].resource.grouping.groupDisplayDisplay name for the group
entry[].resource.grouping.planAn identifier for the plan
entry[].resource.grouping.planDisplayDisplay name for the plan
entry[].resource.beneficiarySubscriber to the policy
entry[].resource.beneficiary.referencePointer to the patient who is the beneficiary
entry[].resource.periodCoverage start and end dates
entry[].resource.period.startCoverage start date
entry[].resource.period.endCoverage end date
entry[].resource.payorIdentifier for the plan or agreement issuer
entry[].resource.payor.referencePointer to the payor (will be a contained resource)
Organization resource for the payor
entry[].resource.contained[].resourceTypeOrganization
entry[].resource.contained[].identifierA list of identifiers for this organization
entry[].resource.contained[].identifier[].value
entry[].resource.contained[].identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.contained[].telecomA contact detail for the patient
entry[].resource.contained[].telecom[].value
entry[].resource.contained[].telecom[].systemContact information for the organization.
Redox currently only supports values of phone and email for this field.
entry[].resource.contained[].telecom[].usePurpose of the contact point
entry[].resource.contained[].nameName of the organization
entry[].resource.contained[].address[]Address[]
Address(es) of the of the organization
entry[].resource.contained[].address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.contained[].address[].cityName of city
entry[].resource.contained[].address[].districtDistrict (county) name
entry[].resource.contained[].address[].stateName, or abbreviation, of the state
entry[].resource.contained[].address[].postalCodePostal code for the area
entry[].resource.contained[].address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
entry[].resource.contained[].address[].useThe purpose of the address
{
"resourceType": "Bundle",
"type": "message",
"entry": [
{
"fullUrl": "urn:uuid:d4e05459-897c-47a3-ba89-c3408332067b",
"resource": {
"id": "transmission-12414",
"resourceType": "MessageHeader",
"event": {
"code": "PatientAdmin-NewPatient"
},
"timestamp": "2018-06-19T23:56:22.180Z",
"source": {
"name": "Redox Dev Tools",
"endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
},
"focus": [
{
"reference": "urn:uuid:2bb60e6c-96a2-4263-afed-5552de413478"
},
{
"reference": "urn:uuid:ce16d6e0-d2d6-4953-8479-c3d067f2930f"
},
{
"reference": "urn:uuid:145315d1-d391-4ce4-a133-3e17fedac797"
}
]
}
},
{
"fullUrl": "urn:uuid:2bb60e6c-96a2-4263-afed-5552de413478",
"resource": {
"resourceType": "Patient",
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
},
{
"value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
},
{
"value": "a1d4ee8aba494ca",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"name": [
{
"family": "Bixby",
"given": [
"Timothy",
"Paul"
]
}
],
"gender": "male",
"maritalStatus": {
"text": "Married",
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
]
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "text",
"valueString": "White"
}
]
}
],
"communication": [
{
"language": {
"text": "en",
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
]
}
}
],
"generalPractitioner": [
{
"reference": "urn:uuid:ce16d6e0-d2d6-4953-8479-c3d067f2930f"
}
]
}
},
{
"fullUrl": "urn:uuid:ce16d6e0-d2d6-4953-8479-c3d067f2930f",
"resource": {
"resourceType": "Practitioner",
"active": true,
"identifier": [
{
"value": "4356789876",
"system": "http://hl7.org/fhir/sid/us-npi"
}
],
"telecom": [
{
"value": "+16085551234",
"system": "phone",
"use": "work"
}
],
"address": [
{
"line": [
"123 Main St."
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53703",
"country": "USA"
}
],
"name": [
{
"family": "Granite",
"given": [
"Pat"
]
}
],
"qualification": [
{
"code": {
"text": "MD",
"coding": [
{
"code": "MD",
"system": "http://hl7.org/fhir/v2/0360/2.7",
"display": "Doctor of Medicine"
}
]
}
}
]
}
},
{
"fullUrl": "urn:uuid:145315d1-d391-4ce4-a133-3e17fedac797",
"resource": {
"identifier": [
{
"value": "9140860055",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:POLNUM"
}
],
"resourceType": "Coverage",
"status": "active",
"grouping": {
"group": "847025-024-0009",
"groupDisplay": "Accelerator Labs",
"plan": "31572",
"planDisplay": "HMO Deductable Plan"
},
"beneficiary": {
"reference": "urn:uuid:2bb60e6c-96a2-4263-afed-5552de413478"
},
"period": {
"start": "2015-01-01",
"end": "2020-12-31"
},
"contained": [
{
"resourceType": "Organization",
"id": "company",
"identifier": [
{
"value": "60054"
}
],
"telecom": [
{
"value": "+18089541123",
"system": "phone"
}
],
"name": "aetna (60054 0131)",
"address": [
{
"line": [
"PO Box 14080"
],
"city": "Lexington",
"district": "Fayette",
"state": "KY",
"postalCode": "40512-4079",
"country": "US"
}
]
}
],
"payor": [
{
"reference": "#company"
}
]
}
}
]
}{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "NewPatient",
"EventDateTime": "2018-06-19T23:56:22.180Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"barb.bixby@test.net"
],
"Roles": [
"Emergency Contact"
]
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
]
}
],
"PCP": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"LastName": "Bixby",
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null
},
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductable Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"LastName": null,
"FirstName": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}A Patient Update message is generated when any patient or registration information changes while the patient is not currently admitted.
Fields
Meta
Meta.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
Patient Update
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
ReliableName of the source
Meta.Destinations[]Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].IDString
ReliableRequiredID for the patient
Patient.Identifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliablePatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossiblePatient's race.
Supported Values
Patient.Demographics.IsHispanicBoolean
PossibleIndicates if the patient is of hispanic origin.
Patient.Demographics.MaritalStatusString
PossiblePatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Patient.Demographics.Citizenship[]Array of strings
PossiblePatient's nation(s) of citizenship.
*In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
Patient.Demographics.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleCountry
Patient.Notes[]Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstNameString
PossibleFirst name of the contact
Patient.Contacts[].MiddleNameString
PossibleMiddle name of the contact
Patient.Contacts[].LastNameString
PossibleLast name of the contact
Patient.Contacts[].AddressObject
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddressString
PossibleStreet address
Patient.Contacts[].Address.CityString
PossibleCity
Patient.Contacts[].Address.StateString
PossibleState
Patient.Contacts[].Address.ZIPString
PossibleZIP
Patient.Contacts[].Address.CountyString
PossibleCounty
Patient.Contacts[].Address.CountryString
PossibleCountry
Patient.Contacts[].PhoneNumber.HomeString
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.OfficeString
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.MobileString
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatientString
PossiblePersonal relationship to the patient.
e.x. Father, Spouse
Patient.Contacts[].EmailAddresses[]Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Patient.Diagnoses[]Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].CodeString
ProbableCode for the diagnosis
Patient.Diagnoses[].CodesetString
ProbableCode set used to identify the diagnosis.
One of the following: ICD-9, ICD-10, HCPCS, CPT
Patient.Diagnoses[].NameString
ProbableName of the diagnosis
Patient.Diagnoses[].TypeString
PossibleList of diagnoses associated with this visit.
One of the following: Admitting, Working, or Final
Patient.Allergies[]Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].CodeString
PossibleCode for the allergy
Patient.Allergies[].CodesetString
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].NameString
PossibleName of the allergy
Patient.Allergies[].OnsetDateTimeString
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].CodeString
PossibleCode for the reaction
Patient.Allergies[].Reaction[].CodesetString
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].NameString
PossibleName of the reaction
Patient.PCPObject
ReliablePrimary Care Provider for the Patient
Patient.PCP.NPIString
ReliableNPI of the PCP
Patient.PCP.IDString
ReliableID of the PCP.
This ID is often required for Inpatient Visits.
Patient.PCP.IDTypeString
ReliableID type of the ID for the PCP
Patient.PCP.FirstNameString
PossibleFirst name of the PCP
Patient.PCP.LastNameString
PossibleLast name of the PCP
Patient.PCP.Credentials[]Array of Strings
PossibleList of credentials for the PCP.
e.g. MD, PhD
Patient.PCP.AddressObject
PossibleProvider's address
Patient.PCP.Address.StreetAddressString
PossibleStreet address
Patient.PCP.Address.CityString
PossibleCity
Patient.PCP.Address.StateString
PossibleState
Patient.PCP.Address.ZIPString
PossibleZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Patient.PCP.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.PCP.LocationObject
PossibleProvider's location
Patient.PCP.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.PCP.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Patient.PCP.Location.DepartmentString
PossibleDepartment
Patient.PCP.Location.RoomString
PossibleRoom.
Example: 136
Patient.PCP.PhoneNumberString
ProbablePCP's phone number.
In E. 164 Format. (i.e. +16085551234)
Patient.PCP.AddressObject
ProbablePCP's address
Patient.PCP.Address.StreetAddressString
ProbableStreet address
Patient.PCP.Address.CityString
ProbableCity
Patient.PCP.Address.StateString
ProbableState
Patient.PCP.Address.ZIPString
ProbableZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Patient.Insurances[]Array of Objects
ProbableList of insurance coverages for the patient
Patient.Insurances[].Plan.IDString
ProbableIdentifier of insurance plan
Patient.Insurances[].Plan.IDTypeString
ProbableID type of insurance plan
Patient.Insurances[].Plan.NameString
ProbableName of insurance plan
Patient.Insurances[].Plan.TypeString
PossibleType of insurance plan
Patient.Insurances[].MemberNumberString
PossiblePatient member number
Patient.Insurances[].Company.IDString
ProbableID of insurance company (payor)
Patient.Insurances[].Company.IDTypeString
ProbableID type of insurance company (payor)
Patient.Insurances[].Company.NameString
ProbableName of insurance company (payor)
Patient.Insurances[].Company.AddressObject
ProbableInsurance company's address
Patient.Insurances[].Company.Address.StreetAddressString
ProbableStreet address
Patient.Insurances[].Company.Address.CityString
ProbableCity
Patient.Insurances[].Company.Address.StateString
ProbableState
Patient.Insurances[].Company.Address.ZIPString
ProbableZIP
Patient.Insurances[].Company.Address.CountyString
PossibleCounty
Patient.Insurances[].Company.Address.CountryString
PossibleCountry
Patient.Insurances[].Company.PhoneNumberString
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Insurances[].GroupNumberString
ProbableInsurance policy group number
Patient.Insurances[].GroupNameString
ProbableInsurance policy group name
Patient.Insurances[].EffectiveDateString
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Patient.Insurances[].ExpirationDateString
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Patient.Insurances[].PolicyNumberString
ProbableInsurance policy number
Patient.Insurances[].AgreementTypeString
ProbableType of insurance agreement.
One of the following: "Standard", "Unified", "Maternity"
Patient.Insurances[].CoverageTypeString
ProbableType of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Patient.Insurances[].InsuredObject
PossibleIndividual who has the agreement with the insurance company for the related policy
Patient.Insurances[].Insured.LastNameString
PossibleLast name of the insured
Patient.Insurances[].Insured.FirstNameString
PossibleFirst name of the insured
Patient.Insurances[].Insured.RelationshipString
PossibleRelationship of the insured to the patient.
One of the following: "Self", "Spouse", "Other".
Patient.Insurances[].Insured.DOBString
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Patient.Insurances[].Insured.SexString
PossibleSex of the insured
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Insured.AddressObject
ProbableAddress of the insured
Patient.Insurances[].Insured.Address.StreetAddressString
ProbableStreet address
Patient.Insurances[].Insured.Address.CityString
ProbableCity
Patient.Insurances[].Insured.Address.StateString
ProbableState
Patient.Insurances[].Insured.Address.ZIPString
ProbableZIP
Patient.Insurances[].Insured.Address.CountyString
PossibleCounty
Patient.Insurances[].Insured.Address.CountryString
PossibleCountry
Patient.GuarantorObject
PossiblePerson ultimately responsible for the bill for the patient.
Patient.Guarantor.NumberString
ProbableNumber of the guarantor
Patient.Guarantor.FirstNameString
ProbableFirst name
Patient.Guarantor.LastNameString
ProbableLast name
Patient.Guarantor.DOBString
PossibleGuarantor's date of birth.
In ISO 8601 format
Patient.Guarantor.SexString
PossibleGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.Spouse.FirstNameString
ProbableSpouse's first name
Patient.Guarantor.Spouse.LastNameString
ProbableSpouse's last name
Patient.Guarantor.AddressObject
ProbableAddress of the guarantor
Patient.Guarantor.Address.StreetAddressString
ProbableStreet address
Patient.Guarantor.Address.CityString
ProbableCity
Patient.Guarantor.Address.StateString
ProbableState
Patient.Guarantor.Address.ZIPString
ProbableZIP
Patient.Guarantor.Address.CountyString
PossibleCounty
Patient.Guarantor.Address.CountryString
PossibleCountry
Patient.Guarantor.PhoneNumber.HomeString
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.PhoneNumber.BusinessString
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.TypeString
ProbableType of guarantor.
E.g. institution, individual
Patient.Guarantor.RelationToPatientString
ProbableRelation to the patient.
E.g. self, parent
Patient.Guarantor.Employer.NameString
ProbableEmployer's name
Patient.Guarantor.Employer.AddressObject
ProbableEmployer's address
Patient.Guarantor.Employer.Address.StreetAddressString
ProbableStreet address
Patient.Guarantor.Employer.Address.CityString
ProbableCity
Patient.Guarantor.Employer.Address.StateString
ProbableState
Patient.Guarantor.Employer.Address.ZIPString
ProbableZIP
Patient.Guarantor.Employer.Address.CountyString
PossibleCounty
Patient.Guarantor.Employer.Address.CountryString
PossibleCountry
Patient.Guarantor.Employer.PhoneNumberString
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
resourceType
resourceTypeBundle
type
typeCurrently, Redox supports only the 'Message' Type
entry
The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
entry[].fullUrlAbsolute URL for resource.
Ex: server address or UUID/OID.
entry[].resource - MessageHeader
MessageHeader Resource Information
entry[].resource.idLogical id of this artifact
entry[].resource.resourceTypeMessageHeader
entry[].resource.eventCode for the event this message represents
entry[].resource.event.code
entry[].resource.timestampTime that the message was sent
Message source application
entry[].resource.source.nameName of the source system
entry[].resource.source.endpointActual message source address or id
entry[].resource.focusPointers to the actual content of the message
entry[].resource.focus[].referenceReferences to the rest of the bundle
entry[].resource - Patient
entry[].resource.resourceTypePatient
entry[].resource.identifierA list of identifiers for this patient
entry[].resource.identifier[].value
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.birthdateData of birth for the patient
entry[].resource.telecomA contact detail for the patient
entry[].resource.telecom[].value
entry[].resource.telecom[].systemA contact detail for the patient.
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the patient
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
entry[].resource.address[].useThe purpose of the address
A list of names associated with the patient
entry[].resource.name[].familyOften called 'Surname.'
entry[].resource.name[].given[]string[]
Administrative gender for the patient.
The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
entry[].resource.maritalStatusMarital Status of a patient
entry[].resource.maritalStatus.text
entry[].resource.extensionAdditional Content defined by implementations
entry[].resource.extension[].url
entry[].resource.extension[].extension
entry[].resource.extension[].extension[].url
entry[].resource.extension[].extension[].valueString
A list of languages which may be used to communicate with the patient.
entry[].resource.communication[].language
entry[].resource.communication[].language.text
entry[].resource.communication[].language.coding
entry[].resource.communication[].language.coding.codeSymbol defined by the system
entry[].resource.communication[].language.coding.systemIdentity/namespace of the terminology system
entry[].resource.communication[].language.coding.displayDisplay value of the code, as defined by the system
entry[].resource - Practitioner
entry[].resource.resourceTypePractitioner
entry[].resource.activeWhether this practitioner's record is in active use
A list of identifiers that apply to this person in this role
entry[].resource.identifier[].valueUnique value identifier
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.telecomContact information for the practitioner
entry[].resource.telecom[].valueActual contact point details
entry[].resource.telecom[].systemA contact detail for the practitioner (that apply to all roles).
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the practitioner.
Address(es) are not role specific.
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
The purpose of the address
The name(s) associated with the practitioner.
entry[].resource.name[].familyFamily name.
Often called 'Surname.'
entry[].resource.name[].given[]string[]
Given names (not always 'first'). Includes middle names.
Given names appear in the correct order for presenting the name.
Qualifications obtained by training and certification.
entry[].resource.qualification[].codeCoded representation of the qualification.
entry[].resource.qualification[].code.textText representation of the qualification.
entry[].resource.qualification[].code.coding
entry[].resource.qualification[].code.coding.codeSymbol defined by the system
entry[].resource.qualification[].code.coding.systemIdentity/namespace of the terminology system
entry[].resource.qualification[].code.coding.displayDisplay value of the code, as defined by the system
entry[].resource - Coverage
entry[].resource.resourceTypeCoverage
entry[].resource.identifierA list of identifiers for this coverage
entry[].resource.identifier[].value
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.statusactive | cancelled | draft | entered-in-error
Additional coverage classifications
entry[].resource.grouping.groupAn identifier for the group
entry[].resource.grouping.groupDisplayDisplay name for the group
entry[].resource.grouping.planAn identifier for the plan
entry[].resource.grouping.planDisplayDisplay name for the plan
entry[].resource.beneficiarySubscriber to the policy
entry[].resource.beneficiary.referencePointer to the patient who is the beneficiary
entry[].resource.periodCoverage start and end dates
entry[].resource.period.startCoverage start date
entry[].resource.period.endCoverage end date
entry[].resource.payorIdentifier for the plan or agreement issuer
entry[].resource.payor.referencePointer to the payor (will be a contained resource)
Organization resource for the payor
entry[].resource.contained[].resourceTypeOrganization
entry[].resource.contained[].identifierA list of identifiers for this organization
entry[].resource.contained[].identifier[].value
entry[].resource.contained[].identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.contained[].telecomA contact detail for the patient
entry[].resource.contained[].telecom[].value
entry[].resource.contained[].telecom[].systemContact information for the organization.
Redox currently only supports values of phone and email for this field.
entry[].resource.contained[].telecom[].usePurpose of the contact point
entry[].resource.contained[].nameName of the organization
entry[].resource.contained[].address[]Address[]
Address(es) of the of the organization
entry[].resource.contained[].address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.contained[].address[].cityName of city
entry[].resource.contained[].address[].districtDistrict (county) name
entry[].resource.contained[].address[].stateName, or abbreviation, of the state
entry[].resource.contained[].address[].postalCodePostal code for the area
entry[].resource.contained[].address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
entry[].resource.contained[].address[].useThe purpose of the address
entry[].resource.resourceTypeCoverage
entry[].resource.identifierA list of identifiers for this coverage
entry[].resource.identifier[].value
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.statusactive | cancelled | draft | entered-in-error
Additional coverage classifications
entry[].resource.grouping.groupAn identifier for the group
entry[].resource.grouping.groupDisplayDisplay name for the group
entry[].resource.grouping.planAn identifier for the plan
entry[].resource.grouping.planDisplayDisplay name for the plan
entry[].resource.beneficiarySubscriber to the policy
entry[].resource.beneficiary.referencePointer to the patient who is the beneficiary
entry[].resource.periodCoverage start and end dates
entry[].resource.period.startCoverage start date
entry[].resource.period.endCoverage end date
entry[].resource.payorIdentifier for the plan or agreement issuer
entry[].resource.payor.referencePointer to the payor (will be a contained resource)
Organization resource for the payor
entry[].resource.contained[].resourceTypeOrganization
entry[].resource.contained[].identifierA list of identifiers for this organization
entry[].resource.contained[].identifier[].value
entry[].resource.contained[].identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.contained[].telecomA contact detail for the patient
entry[].resource.contained[].telecom[].value
entry[].resource.contained[].telecom[].systemContact information for the organization.
Redox currently only supports values of phone and email for this field.
entry[].resource.contained[].telecom[].usePurpose of the contact point
entry[].resource.contained[].nameName of the organization
entry[].resource.contained[].address[]Address[]
Address(es) of the of the organization
entry[].resource.contained[].address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.contained[].address[].cityName of city
entry[].resource.contained[].address[].districtDistrict (county) name
entry[].resource.contained[].address[].stateName, or abbreviation, of the state
entry[].resource.contained[].address[].postalCodePostal code for the area
entry[].resource.contained[].address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
entry[].resource.contained[].address[].useThe purpose of the address
{
"resourceType": "Bundle",
"type": "message",
"entry": [
{
"fullUrl": "urn:uuid:296661e4-ef8b-4ef3-a384-900c5ace54cd",
"resource": {
"id": "transmission-12414",
"resourceType": "MessageHeader",
"event": {
"code": "PatientAdmin-PatientUpdate"
},
"timestamp": "2018-06-19T23:56:22.180Z",
"source": {
"name": "Redox Dev Tools",
"endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
},
"focus": [
{
"reference": "urn:uuid:aca82d0b-311f-4dbe-90de-f7388fe9f80d"
},
{
"reference": "urn:uuid:5b0326d3-e6ad-4929-bdb3-f90edaa51649"
},
{
"reference": "urn:uuid:4cd87dd5-236c-4393-be65-e5c3b252fc87"
}
]
}
},
{
"fullUrl": "urn:uuid:aca82d0b-311f-4dbe-90de-f7388fe9f80d",
"resource": {
"resourceType": "Patient",
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
},
{
"value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
},
{
"value": "a1d4ee8aba494ca",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
}
],
"address": [
{
"line": [
"4435 Victoria Ln"
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53719",
"country": "US",
"use": "home"
}
],
"name": [
{
"family": "Bixby",
"given": [
"Timothy",
"Paul"
]
}
],
"gender": "male",
"maritalStatus": {
"text": "Married",
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
]
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "text",
"valueString": "White"
}
]
}
],
"communication": [
{
"language": {
"text": "en",
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
]
}
}
],
"generalPractitioner": [
{
"reference": "urn:uuid:5b0326d3-e6ad-4929-bdb3-f90edaa51649"
}
]
}
},
{
"fullUrl": "urn:uuid:5b0326d3-e6ad-4929-bdb3-f90edaa51649",
"resource": {
"resourceType": "Practitioner",
"active": true,
"identifier": [
{
"value": "4356789876",
"system": "http://hl7.org/fhir/sid/us-npi"
}
],
"address": [
{
"line": [
"123 Main St."
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53703",
"country": "USA"
}
],
"name": [
{
"family": "Granite",
"given": [
"Pat"
]
}
],
"qualification": [
{
"code": {
"text": "MD",
"coding": [
{
"code": "MD",
"system": "http://hl7.org/fhir/v2/0360/2.7",
"display": "Doctor of Medicine"
}
]
}
}
]
}
},
{
"fullUrl": "urn:uuid:4cd87dd5-236c-4393-be65-e5c3b252fc87",
"resource": {
"identifier": [
{
"value": "9140860055",
"system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:POLNUM"
}
],
"resourceType": "Coverage",
"status": "active",
"grouping": {
"group": "847025-024-0009",
"groupDisplay": "Accelerator Labs",
"plan": "31572",
"planDisplay": "HMO Deductable Plan"
},
"beneficiary": {
"reference": "urn:uuid:aca82d0b-311f-4dbe-90de-f7388fe9f80d"
},
"period": {
"start": "2015-01-01",
"end": "2020-12-31"
},
"contained": [
{
"resourceType": "Organization",
"id": "company",
"identifier": [
{
"value": "60054"
}
],
"telecom": [
{
"value": "+18089541123",
"system": "phone"
}
],
"name": "aetna (60054 0131)",
"address": [
{
"line": [
"PO Box 14080"
],
"city": "Lexington",
"district": "Fayette",
"state": "KY",
"postalCode": "40512-4079",
"country": "US"
}
]
}
],
"payor": [
{
"reference": "#company"
}
]
}
}
]
}{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "PatientUpdate",
"EventDateTime": "2018-06-19T23:56:22.180Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4435 Victoria Ln",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "US"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"barb.bixby@test.net"
],
"Roles": [
"Emergency Contact"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
]
}
],
"PCP": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductable Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"LastName": null,
"FirstName": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
],
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"LastName": "Bixby",
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null
},
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
}
}
}The PatientMerge event type indicates that two patient records should be combined. This typically occurs when a health system determines that documentation for the same patient has occurred on two separate patient records.
Patient.Identifierscontains the identifiers for the record that will be used going forward. The identifiers inPatient.PreviousIdentifiersshould be retired and the patient they refer to combined into the record indicated byPatient.Identifiers.The logic for combining records will be specific to your app. If you have a record for only one of the patients in the message, update the identifiers to match the identifiers in
Patient.Identifiers.The full
Patientobject is included in the message to provide extra context when available.
Fields
Meta
Meta.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
E.g. New, Update
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
ReliableName of the source
Meta.Destinations[]Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].IDString
ReliableRequiredID for the patient
Patient.Identifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.PreviousIdentifiers[]Array of Objects
ReliableList of identifiers for the patient record that should be merged into the record identified by
Patient.Identifiers. These identifiers should be deprecated.
Patient.PreviousIdentifiers[].IDString
ReliableRequired
Patient.PreviousIdentifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliablePatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossiblePatient's race.
Supported Values
Patient.Demographics.IsHispanicBoolean
PossibleIndicates if the patient is of hispanic origin.
Patient.Demographics.MaritalStatusString
PossiblePatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Patient.Demographics.Citizenship[]Array of strings
PossiblePatient's nation(s) of citizenship.
*In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
Patient.Demographics.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleCountry
Patient.Notes[]Array of strings
PossiblePatient-level notes
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "PatientMerge",
"EventDateTime": "2018-06-19T23:56:22.180Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"PreviousIdentifiers": [
{
"ID": "53700",
"IDType": "MR"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
}
}A Pre-Admit event is used to prepare an admission or encounter. This event may allow for creating a patient, as well as creating a visit. For example, a pre-admit may be used prior to surgery so that lab tests can be performed. It may also be used to update the Emergency Department with an expected patient.
Fields
Meta
Meta.DataModelString
ReliableRequiredData model.
E.g. Scheduling, Results
Meta.EventTypeString
ReliableRequiredType of event.
Registration
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
ReliableName of the source
Meta.Destinations[]Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox
Meta.FacilityCodeString
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].IDString
ReliableRequiredID for the patient
Patient.Identifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliablePatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossiblePatient's race.
Supported Values
Patient.Demographics.IsHispanicBoolean
PossibleIndicates if the patient is of hispanic origin.
Patient.Demographics.MaritalStatusString
PossiblePatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.LanguageString
PossiblePatient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values
Patient.Demographics.Citizenship[]Array of strings
PossiblePatient's nation(s) of citizenship.
*In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
Patient.Demographics.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleCountry
Patient.Notes[]Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstNameString
PossibleFirst name of the contact
Patient.Contacts[].MiddleNameString
PossibleMiddle name of the contact
Patient.Contacts[].LastNameString
PossibleLast name of the contact
Patient.Contacts[].AddressObject
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddressString
PossibleStreet address
Patient.Contacts[].Address.CityString
PossibleCity
Patient.Contacts[].Address.StateString
PossibleState
Patient.Contacts[].Address.ZIPString
PossibleZIP
Patient.Contacts[].Address.CountyString
PossibleCounty
Patient.Contacts[].Address.CountryString
PossibleCountry
Patient.Contacts[].PhoneNumber.HomeString
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.OfficeString
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.MobileString
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatientString
PossiblePersonal relationship to the patient.
e.x. Father, Spouse
Patient.Contacts[].EmailAddresses[]Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Patient.Diagnoses[]Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].CodeString
ProbableCode for the diagnosis
Patient.Diagnoses[].CodesetString
ProbableCode set used to identify the diagnosis.
One of the following: ICD-9, ICD-10, HCPCS, CPT
Patient.Diagnoses[].NameString
ProbableName of the diagnosis
Patient.Diagnoses[].TypeString
PossibleList of diagnoses associated with this visit.
One of the following: Admitting, Working, or Final
Patient.Allergies[]Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].CodeString
PossibleCode for the allergy
Patient.Allergies[].CodesetString
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].NameString
PossibleName of the allergy
Patient.Allergies[].OnsetDateTimeString
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].CodeString
PossibleCode for the reaction
Patient.Allergies[].Reaction[].CodesetString
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].NameString
PossibleName of the reaction
Patient.PCPObject
ReliablePrimary Care Provider for the Patient
Patient.PCP.NPIString
ReliableNPI of the PCP
Patient.PCP.IDString
ReliableID of the PCP.
This ID is often required for Inpatient Visits.
Patient.PCP.IDTypeString
ReliableID type of the ID for the PCP
Patient.PCP.FirstNameString
PossibleFirst name of the PCP
Patient.PCP.LastNameString
PossibleLast name of the PCP
Patient.PCP.Credentials[]Array of Strings
PossibleList of credentials for the PCP.
e.g. MD, PhD
Patient.PCP.AddressObject
PossibleProvider's address
Patient.PCP.Address.StreetAddressString
PossibleStreet address
Patient.PCP.Address.CityString
PossibleCity
Patient.PCP.Address.StateString
PossibleState
Patient.PCP.Address.ZIPString
PossibleZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Patient.PCP.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.PCP.LocationObject
PossibleProvider's location
Patient.PCP.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.PCP.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Patient.PCP.Location.DepartmentString
PossibleDepartment
Patient.PCP.Location.RoomString
PossibleRoom.
Example: 136
Patient.PCP.PhoneNumberString
ProbablePCP's phone number.
In E. 164 Format. (i.e. +16085551234)
Patient.PCP.AddressObject
ProbablePCP's address
Patient.PCP.Address.StreetAddressString
ProbableStreet address
Patient.PCP.Address.CityString
ProbableCity
Patient.PCP.Address.StateString
ProbableState
Patient.PCP.Address.ZIPString
ProbableZIP
Patient.PCP.Address.CountyString
PossibleCounty
Patient.PCP.Address.CountryString
PossibleCountry
Visit
Visit.VisitNumberString
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumberString
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClassString
ReliableRequiredPatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTimeString
ReliableDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.DurationNumeric
ProbableLength of visit.
In minutes
Visit.ReasonString
ProbableReason for visit
Visit.Instructions[]Array of Strings
ProbableAppointment instructions
Visit.BalanceNumeric
PossiblePatient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.
Visit.AttendingProvider.IDString
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDTypeString
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstNameString
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastNameString
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.AddressObject
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddressString
PossibleStreet address
Visit.AttendingProvider.Address.CityString
PossibleCity
Visit.AttendingProvider.Address.StateString
PossibleState
Visit.AttendingProvider.Address.ZIPString
PossibleZIP
Visit.AttendingProvider.Address.CountyString
PossibleCounty
Visit.AttendingProvider.Address.CountryString
PossibleCountry
Visit.AttendingProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.LocationObject
PossibleProvider's location
Visit.AttendingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.DepartmentString
PossibleDepartment
Visit.AttendingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ConsultingProvider.IDString
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDTypeString
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstNameString
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastNameString
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.AddressObject
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddressString
PossibleStreet address
Visit.ConsultingProvider.Address.CityString
PossibleCity
Visit.ConsultingProvider.Address.StateString
PossibleState
Visit.ConsultingProvider.Address.ZIPString
PossibleZIP
Visit.ConsultingProvider.Address.CountyString
PossibleCounty
Visit.ConsultingProvider.Address.CountryString
PossibleCountry
Visit.ConsultingProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.LocationObject
PossibleProvider's location
Visit.ConsultingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.DepartmentString
PossibleDepartment
Visit.ConsultingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ReferringProvider.IDString
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDTypeString
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstNameString
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastNameString
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.AddressObject
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddressString
PossibleStreet address
Visit.ReferringProvider.Address.CityString
PossibleCity
Visit.ReferringProvider.Address.StateString
PossibleState
Visit.ReferringProvider.Address.ZIPString
PossibleZIP
Visit.ReferringProvider.Address.CountyString
PossibleCounty
Visit.ReferringProvider.Address.CountryString
PossibleCountry
Visit.ReferringProvider.PhoneNumber.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.LocationObject
PossibleProvider's location
Visit.ReferringProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.DepartmentString
PossibleDepartment
Visit.ReferringProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.LocationObject
ProbableLocation of the appointment
Visit.Location.TypeString
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.FacilityString
ProbableFacility.
Example: Community Hospital
Visit.Location.DepartmentString
ProbableDepartment
Visit.Location.RoomString
ProbableRoom.
Example: 136
Visit.Location.BedString
ProbableBed.
Example: B
Visit.Location.AddressObject
ProbableAddress of the appointment location
Visit.Location.Address.StreetAddressString
ProbableStreet address
Visit.Location.Address.CityString
ProbableCity
Visit.Location.Address.StateString
ProbableState
Visit.Location.Address.ZIPString
ProbableZIP
Visit.Location.Address.CountyString
PossibleCounty
Visit.Location.Address.CountryString
PossibleCountry
Visit.GuarantorObject
PossiblePerson ultimately responsible for the bill of the appointment
Visit.Guarantor.NumberString
ProbableNumber of the guarantor
Visit.Guarantor.FirstNameString
ProbableFirst name
Visit.Guarantor.LastNameString
ProbableLast name
Visit.Guarantor.DOBString
PossibleGuarantor's date of birth.
In ISO 8601 format
Visit.Guarantor.SexString
PossibleGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Spouse.FirstNameString
ProbableSpouse's first name
Visit.Guarantor.Spouse.LastNameString
ProbableSpouse's last name
Visit.Guarantor.AddressObject
ProbableAddress of the guarantor
Visit.Guarantor.Address.StreetAddressString
ProbableStreet address
Visit.Guarantor.Address.CityString
ProbableCity
Visit.Guarantor.Address.StateString
ProbableState
Visit.Guarantor.Address.ZIPString
ProbableZIP
Visit.Guarantor.Address.CountyString
PossibleCounty
Visit.Guarantor.Address.CountryString
PossibleCountry
Visit.Guarantor.PhoneNumber.HomeString
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.BusinessString
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.TypeString
ProbableType of guarantor.
E.g. institution, individual
Visit.Guarantor.RelationToPatientString
ProbableRelation to the patient.
E.g. self, parent
Visit.Guarantor.Employer.NameString
ProbableEmployer's name
Visit.Guarantor.Employer.AddressObject
ProbableEmployer's address
Visit.Guarantor.Employer.Address.StreetAddressString
ProbableStreet address
Visit.Guarantor.Employer.Address.CityString
ProbableCity
Visit.Guarantor.Employer.Address.StateString
ProbableState
Visit.Guarantor.Employer.Address.ZIPString
ProbableZIP
Visit.Guarantor.Employer.Address.CountyString
PossibleCounty
Visit.Guarantor.Employer.Address.CountryString
PossibleCountry
Visit.Guarantor.Employer.PhoneNumberString
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[]Array of Objects
ProbableList of insurance coverages for the patient
Visit.Insurances[].Plan.IDString
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDTypeString
ProbableID type of insurance plan
Visit.Insurances[].Plan.NameString
ProbableName of insurance plan
Visit.Insurances[].Plan.TypeString
PossibleType of insurance plan
Visit.Insurances[].MemberNumberString
PossiblePatient member number
Visit.Insurances[].Company.IDString
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDTypeString
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.NameString
ProbableName of insurance company (payor)
Visit.Insurances[].Company.AddressObject
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddressString
ProbableStreet address
Visit.Insurances[].Company.Address.CityString
ProbableCity
Visit.Insurances[].Company.Address.StateString
ProbableState
Visit.Insurances[].Company.Address.ZIPString
ProbableZIP
Visit.Insurances[].Company.Address.CountyString
PossibleCounty
Visit.Insurances[].Company.Address.CountryString
PossibleCountry
Visit.Insurances[].Company.PhoneNumberString
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumberString
ProbableInsurance policy group number
Visit.Insurances[].GroupNameString
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDateString
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDateString
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumberString
ProbableInsurance policy number
Visit.Insurances[].AgreementTypeString
ProbableType of insurance agreement.
One of the following: "Standard", "Unified", "Maternity"
Visit.Insurances[].CoverageTypeString
ProbableType of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Visit.Insurances[].InsuredObject
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.LastNameString
PossibleLast name of the insured
Visit.Insurances[].Insured.FirstNameString
PossibleFirst name of the insured
Visit.Insurances[].Insured.RelationshipString
PossibleRelationship of the insured to the patient.
One of the following: "Self", "Spouse", "Other".
Visit.Insurances[].Insured.DOBString
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.SexString
PossibleSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.AddressObject
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddressString
ProbableStreet address
Visit.Insurances[].Insured.Address.CityString
ProbableCity
Visit.Insurances[].Insured.Address.StateString
ProbableState
Visit.Insurances[].Insured.Address.ZIPString
ProbableZIP
Visit.Insurances[].Insured.Address.CountyString
PossibleCounty
Visit.Insurances[].Insured.Address.CountryString
PossibleCountry
resourceType
resourceTypeBundle
type
typeCurrently, Redox supports only the 'Message' Type
entry
The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
entry[].fullUrlAbsolute URL for resource.
Ex: server address or UUID/OID.
entry[].resource - MessageHeader
MessageHeader Resource Information
entry[].resource.idLogical id of this artifact
entry[].resource.resourceTypeMessageHeader
entry[].resource.eventCode for the event this message represents
entry[].resource.event.code
entry[].resource.timestampTime that the message was sent
Message source application
entry[].resource.source.nameName of the source system
entry[].resource.source.endpointActual message source address or id
entry[].resource.focusPointers to the actual content of the message
entry[].resource.focus[].referenceReferences to the rest of the bundle
entry[].resource - Patient
entry[].resource.resourceTypePatient
entry[].resource.identifierA list of identifiers for this patient
entry[].resource.identifier[].value
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.birthdateData of birth for the patient
entry[].resource.telecomA contact detail for the patient
entry[].resource.telecom[].value
entry[].resource.telecom[].systemA contact detail for the patient.
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the patient
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
entry[].resource.address[].useThe purpose of the address
A list of names associated with the patient
entry[].resource.name[].familyOften called 'Surname.'
entry[].resource.name[].given[]string[]
Administrative gender for the patient.
The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
entry[].resource.maritalStatusMarital Status of a patient
entry[].resource.maritalStatus.text
entry[].resource.extensionAdditional Content defined by implementations
entry[].resource.extension[].url
entry[].resource.extension[].extension
entry[].resource.extension[].extension[].url
entry[].resource.extension[].extension[].valueString
A list of languages which may be used to communicate with the patient.
entry[].resource.communication[].language
entry[].resource.communication[].language.text
entry[].resource.communication[].language.coding
entry[].resource.communication[].language.coding.codeSymbol defined by the system
entry[].resource.communication[].language.coding.systemIdentity/namespace of the terminology system
entry[].resource.communication[].language.coding.displayDisplay value of the code, as defined by the system
entry[].resource - Practitioner
entry[].resource.resourceTypePractitioner
entry[].resource.activeWhether this practitioner's record is in active use
A list of identifiers that apply to this person in this role
entry[].resource.identifier[].valueUnique value identifier
entry[].resource.identifier[].systemEstablishes the namespace for the value - that is, a URL that describes a set of values that are unique
entry[].resource.telecomContact information for the practitioner
entry[].resource.telecom[].valueActual contact point details
entry[].resource.telecom[].systemA contact detail for the practitioner (that apply to all roles).
Redox currently only supports values of phone and email for this field.
entry[].resource.telecom[].usePurpose of the contact point
entry[].resource.addressAddress(es) of the practitioner.
Address(es) are not role specific.
entry[].resource.address[].line[]string[]
Street name, number, direction & P.O. Box etc.
entry[].resource.address[].cityName of city
entry[].resource.address[].districtDistrict (county) name
entry[].resource.address[].stateName, or abbreviation, of the state
entry[].resource.address[].postalCodePostal code for the area
entry[].resource.address[].countryCountry.
Can be ISO 3166 2 or 3 letter code.
The purpose of the address
The name(s) associated with the practitioner.
entry[].resource.name[].familyFamily name.
Often called 'Surname.'
entry[].resource.name[].given[]string[]
Given names (not always 'first'). Includes middle names.
Given names appear in the correct order for presenting the name.
Qualifications obtained by training and certification.
entry[].resource.qualification[].codeCoded representation of the qualification.
entry[].resource.qualification[].code.textText representation of the qualification.
entry[].resource.qualification[].code.coding
entry[].resource.qualification[].code.coding.codeSymbol defined by the system
entry[].resource.qualification[].code.coding.systemIdentity/namespace of the terminology system
entry[].resource.qualification[].code.coding.displayDisplay value of the code, as defined by the system