Redox | FHIR.Message.PatientAdmin

Table of Contents

FHIR.Message.PatientAdmin

patient-arrived
patient-created
patient-discharged
patient-merged
patient-pre-admitted
patient-registered
patient-transferred
patient-updated

patient-arrived

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Message.PatientAdmin
- Meta.EventType
  String
  Reliable
  Required
  patient-arrived
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "PatientAdminPatientArrivedBundleExample",
   "type": "message",
   "entry": [
      {
         "resource": {
            "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminPatientArrived",
            "resourceType": "MessageHeader",
            "id": "PatientArrivedMessageHeader",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "focus": [
               {
                  "reference": "Patient/RedoxPatientExampleTimothyMinimal"
               },
               {
                  "reference": "Encounter/RedoxEncounterExampleMinimal"
               }
            ],
            "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminPatientArrivedLight"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=M23462346|urn:redox:MRN",
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyMinimal",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:health-one:MR"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
         "resource": {
            "resourceType": "Encounter",
            "id": "RedoxEncounterExampleMinimal",
            "status": "arrived",
            "class": {
               "code": "AMB",
               "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
            },
            "type": [
               {
                  "extension": [
                     {
                        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                        "valueCode": "unknown"
                     }
                  ]
               }
            ],
            "subject": {
               "reference": "Patient/RedoxPatientExampleTimothyMinimal"
            }
         }
      }
   ],
   "timestamp": "2021-06-17T20:33:22.422Z",
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Message.PatientAdmin",
      "EventType": "patient-arrived"
   }
}

patient-created

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Message.PatientAdmin
- Meta.EventType
  String
  Reliable
  Required
  patient-created
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "PatientAdminPatientCreatedBundleExample",
   "type": "message",
   "entry": [
      {
         "resource": {
            "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminPatientCreated",
            "resourceType": "MessageHeader",
            "id": "PatientCreatedMessageHeader",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "focus": [
               {
                  "reference": "Patient/RedoxPatientExampleTimothyMinimal"
               }
            ],
            "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminPatientCreatedLight"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=M23462346|urn:redox:MRN",
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyMinimal",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:health-one:MR"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06"
         }
      }
   ],
   "timestamp": "2021-06-17T20:33:22.422Z",
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Message.PatientAdmin",
      "EventType": "patient-created"
   }
}

patient-discharged

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Message.PatientAdmin
- Meta.EventType
  String
  Reliable
  Required
  patient-discharged
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "PatientAdminPatientDischargedBundleExample",
   "type": "message",
   "entry": [
      {
         "resource": {
            "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminPatientDischarged",
            "resourceType": "MessageHeader",
            "id": "PatientDischargedMessageHeader",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "focus": [
               {
                  "reference": "Patient/RedoxPatientExampleTimothyMinimal"
               },
               {
                  "reference": "Encounter/RedoxEncounterExampleMinimal"
               }
            ],
            "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminPatientDischargedLight"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=M23462346|urn:redox:MRN",
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyMinimal",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:health-one:MR"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
         "resource": {
            "resourceType": "Encounter",
            "id": "RedoxEncounterExampleMinimal",
            "status": "arrived",
            "class": {
               "code": "AMB",
               "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
            },
            "type": [
               {
                  "extension": [
                     {
                        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                        "valueCode": "unknown"
                     }
                  ]
               }
            ],
            "subject": {
               "reference": "Patient/RedoxPatientExampleTimothyMinimal"
            }
         }
      }
   ],
   "timestamp": "2021-06-17T20:33:22.422Z",
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Message.PatientAdmin",
      "EventType": "patient-discharged"
   }
}

patient-merged

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Message.PatientAdmin
- Meta.EventType
  String
  Reliable
  Required
  patient-merged
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "PatientAdminPatientMergedBundleExample",
   "type": "message",
   "entry": [
      {
         "resource": {
            "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminPatientMerged",
            "resourceType": "MessageHeader",
            "id": "PatientMergedMessageHeader",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "focus": [
               {
                  "reference": "Patient/RedoxPatientExampleTimothyMinimalMergedNew"
               }
            ],
            "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminPatientMergedLight"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothyMinimalMergedNew",
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyMinimalMergedNew",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:health-one:MR"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "link": [
               {
                  "other": {
                     "reference": "Patient/RedoxPatientExampleTimothyMinimalMergedOld"
                  },
                  "type": "replaces"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothyMinimalMergedOld",
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyMinimalMergedOld",
            "identifier": [
               {
                  "value": "0000000002",
                  "system": "urn:redox:health-one:MR"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "link": [
               {
                  "other": {
                     "reference": "Patient/RedoxPatientExampleTimothyMinimalMergedNew"
                  },
                  "type": "replaced-by"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06"
         }
      }
   ],
   "timestamp": "2021-06-17T20:33:22.422Z",
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Message.PatientAdmin",
      "EventType": "patient-merged"
   }
}

patient-pre-admitted

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Message.PatientAdmin
- Meta.EventType
  String
  Reliable
  Required
  patient-pre-admitted
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "PatientAdminPatientPreAdmittedBundleExample",
   "type": "message",
   "entry": [
      {
         "resource": {
            "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminPatientPreAdmitted",
            "resourceType": "MessageHeader",
            "id": "PatientPreAdmitMessageHeader",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "focus": [
               {
                  "reference": "Patient/RedoxPatientExampleTimothyMinimal"
               },
               {
                  "reference": "Encounter/RedoxEncounterExampleMinimal"
               }
            ],
            "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminPatientPreAdmittedLight"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=M23462346|urn:redox:MRN",
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyMinimal",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:health-one:MR"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
         "resource": {
            "resourceType": "Encounter",
            "id": "RedoxEncounterExampleMinimal",
            "status": "arrived",
            "class": {
               "code": "AMB",
               "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
            },
            "type": [
               {
                  "extension": [
                     {
                        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                        "valueCode": "unknown"
                     }
                  ]
               }
            ],
            "subject": {
               "reference": "Patient/RedoxPatientExampleTimothyMinimal"
            }
         }
      }
   ],
   "timestamp": "2021-12-17T20:33:22.422Z",
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Message.PatientAdmin",
      "EventType": "patient-pre-admitted"
   }
}

patient-registered

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Message.PatientAdmin
- Meta.EventType
  String
  Reliable
  Required
  patient-registered
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "PatientAdminPatientRegisteredBundleExample",
   "type": "message",
   "entry": [
      {
         "resource": {
            "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminPatientRegistered",
            "resourceType": "MessageHeader",
            "id": "PatientRegisteredMessageHeader",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "focus": [
               {
                  "reference": "Patient/RedoxPatientExampleTimothyMinimal"
               },
               {
                  "reference": "Encounter/RedoxEncounterExampleMinimal"
               }
            ],
            "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminPatientRegisteredLight"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=M23462346|urn:redox:MRN",
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyMinimal",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:health-one:MR"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
         "resource": {
            "resourceType": "Encounter",
            "id": "RedoxEncounterExampleMinimal",
            "status": "arrived",
            "class": {
               "code": "AMB",
               "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
            },
            "type": [
               {
                  "extension": [
                     {
                        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                        "valueCode": "unknown"
                     }
                  ]
               }
            ],
            "subject": {
               "reference": "Patient/RedoxPatientExampleTimothyMinimal"
            }
         }
      }
   ],
   "timestamp": "2021-06-17T20:33:22.422Z",
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Message.PatientAdmin",
      "EventType": "patient-registered"
   }
}

patient-transferred

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Message.PatientAdmin
- Meta.EventType
  String
  Reliable
  Required
  patient-transferred
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "PatientAdminPatientTransferredBundleExample",
   "type": "message",
   "entry": [
      {
         "resource": {
            "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminPatientTransferred",
            "resourceType": "MessageHeader",
            "id": "PatientTransferredMessageHeader",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "focus": [
               {
                  "reference": "Patient/RedoxPatientExampleTimothyMinimal"
               },
               {
                  "reference": "Encounter/RedoxEncounterExampleMinimal"
               }
            ],
            "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminPatientTransferredLight"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=M23462346|urn:redox:MRN",
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyMinimal",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:health-one:MR"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
         "resource": {
            "resourceType": "Encounter",
            "id": "RedoxEncounterExampleMinimal",
            "status": "arrived",
            "class": {
               "code": "AMB",
               "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
            },
            "type": [
               {
                  "extension": [
                     {
                        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                        "valueCode": "unknown"
                     }
                  ]
               }
            ],
            "subject": {
               "reference": "Patient/RedoxPatientExampleTimothyMinimal"
            }
         }
      }
   ],
   "timestamp": "2021-06-17T20:33:22.422Z",
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Message.PatientAdmin",
      "EventType": "patient-transferred"
   }
}

patient-updated

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Message.PatientAdmin
- Meta.EventType
  String
  Reliable
  Required
  patient-updated
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "PatientAdminPatientUpdatedBundleExample",
   "type": "message",
   "entry": [
      {
         "resource": {
            "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminPatientUpdated",
            "resourceType": "MessageHeader",
            "id": "PatientUpdatedMessageHeader",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "focus": [
               {
                  "reference": "Patient/RedoxPatientExampleTimothyMinimal"
               }
            ],
            "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminPatientUpdatedLight"
         }
      },
      {
         "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=M23462346|urn:redox:MRN",
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyMinimal",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:health-one:MR"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06"
         }
      }
   ],
   "timestamp": "2021-06-17T20:33:22.422Z",
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Message.PatientAdmin",
      "EventType": "patient-updated"
   }
}

FHIR.Message.PatientAdmin

patient-arrivedlink

Fields

Meta

patient-createdlink

Fields

Meta

patient-dischargedlink

Fields

Meta

patient-mergedlink

Fields

Meta

patient-pre-admittedlink

Fields

Meta

patient-registeredlink

Fields

Meta

patient-transferredlink

Fields

Meta

patient-updatedlink

Fields

Meta

patient-arrived

patient-created

patient-discharged

patient-merged

patient-pre-admitted

patient-registered

patient-transferred

patient-updated