This resource contains details and outcomes for a patient encounter, which can include one or more providers, locations, and services. Encounters can encompass preadmission, outpatient visits, telehealth visits, inpatient stays, and discharges, depending on the organization and context for the encounter. Encounters can contain references to procedures if a procedure was completed during a patient visit or if a follow-up procedure is scheduled as a result of the encounter.
You can receive or retrieve encounter details.
We support any valid FHIR® field. However, we only display the fields that we’ve defined in the schema, which are usually based on what’s included in the US Core profile.
cURL request example
curl 'https://api.redoxengine.com/fhir/R4/{destinationId}/{environmentFlag}/Encounter/$write' \--request POST \--header 'Authorization: Bearer $API_TOKEN' \--header 'Content-Type: application/fhir+json' \--data '{"resourceType": "Bundle","id": "RedoxEncounterMessageBundleExample","type": "message","timestamp": "2021-12-17T20:33:22.422Z","entry": [{"resource": {"resourceType": "MessageHeader","id": "RedoxMessageHeaderExample","source": {"name": "Good Health Clinics","endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"},"eventCoding": {"system": "urn:redox:event-type","code": "Encounter-New"}}},{"resource": {"resourceType": "Encounter","id": "RedoxEncounterExample","identifier": [{"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11","value": "9601346482"}],"status": "finished","class": {"code": "IMP","system": "http://terminology.hl7.org/CodeSystem/v3-ActCode","display": "inpatient encounter"},"type": [{"coding": [{"code": "99222","system": "http://www.ama-assn.org/go/cpt","display": "InPatient Admission"}]}],"diagnosis": [{"condition": {"reference": "Condition/RedoxConditionExampleEncounterDx"}}],"participant": [{"individual": {"reference": "Practitioner/RedoxPractitionerExampleEncounter"}}],"location": [{"location": {"reference": "Location/RedoxLocationExampleEncounter"}}],"subject": {"reference": "Patient/RedoxPatientExampleTimothy"},"period": {"start": "2022-02-06T04:00:00.000Z","end": "2022-02-06T04:15:00.000Z"},"length": {"value": 16,"code": "m","system": "http://unitsofmeasure.org"},"reasonCode": [{"coding": [{"code": "23360407","system": "http://snomed.info/sct"}],"text": "Pneumonia"}]},"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId"},{"resource": {"resourceType": "Patient","id": "RedoxPatientExampleTimothy","meta": {"extension": [{"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order","valueInteger": 1}]},"extension": [{"extension": [{"url": "text","valueString": "White"}],"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"},{"extension": [{"url": "ombCategory","valueCoding": {"code": "2135-2","system": "urn:oid:2.16.840.1.113883.6.238","display": "Hispanic or Latino"}},{"url": "text","valueString": "Hispanic"}],"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"}],"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","use": "official"},{"text": "Billy","use": "usual"}],"gender": "male","birthDate": "2008-01-06","telecom": [{"value": "+18088675301","system": "phone","use": "home"},{"value": "+18008675309","system": "phone","use": "work"},{"value": "timothy.bixby@redoxengine.com","system": "email"}],"address": [{"line": ["4762 Hickory Street"],"city": "Monroe","district": "Greene","state": "WI","postalCode": "53566","country": "US","use": "home"}],"maritalStatus": {"coding": [{"code": "M","system": "http://hl7.org/fhir/v3/MaritalStatus","display": "Married"}],"text": "Married"},"communication": [{"language": {"coding": [{"code": "en","system": "urn:ietf:bcp:47"}],"text": "English"}}],"contact": [{"name": {"given": ["Barbara"],"family": "Bixby"},"telecom": [{"value": "+18088675303","system": "phone","use": "home"},{"value": "barbara.bixby@redoxengine.com","system": "email"}],"address": {"line": ["4762 Hickory St."],"city": "Monroe","district": "Green","state": "WI","postalCode": "53566","country": "USA"},"relationship": [{"coding": [{"code": "MTH","system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode","display": "mother"}],"text": "Mother"},{"coding": [{"code": "C","system": "http://terminology.hl7.org/CodeSystem/v2-0131","display": "Emergency Contact"}],"text": "Emergency Contact"}]}],"generalPractitioner": [{"reference": "Practitioner/RedoxPractitionerExamplePat"}],"managingOrganization": {"reference": "Organization/RedoxOrganizationManagingExample"}},"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN"}]}'
Identifies the type of the resource
BundleIdentifies this bundle as a message
messageAn array of FHIR resources. At a minimum, an Encounter should include the following entries:
An entry in the bundle containing a FHIR resource
Additional metadata about the message including the event
Identifies the type of the resource
MessageHeaderInformation about the sender of the message. This will typically be populated by Redox.
Identifies the routing target to send acknowledgements to.
Human-readable name for the source system.
This describes the message being communicated
The identification of the code system that defines the meaning of the symbol in the code.
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Encounter-NewThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.