This is the API documentation for the OpenMRS FHIR Module ,Encounter Resource.
Encounter Resource represents an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. For more information please refer http://hl7-fhir.github.io/encounter.html
Shown below is an example of how an OpenMRS Encounter objects would map to FHIR Encounter resource, as proposed by Grahame Grieve.
The left side of the relationship indicates the OpenMRS attribute, while the right indicated the FHIR resource mapping.
Encounter
Integer uuid :: n/a - goes in the URL e.g. [base]/Encounter/[encounterId] Date encounterDatetime :: Encounter.period Patient patient :: Encounter.subject Integer patientId :: not mapped Set<EncounterProvider> encounterProviders :: Encounter.participant Location location :: Encounter.location EncounterType encounterType : not mapped Set<Order> orders :: not mapped Visit visit :: Encounter.partOf
Shown below is a sample FHIR Encounter Resource.
FHIR Encounter Resource
{
resourceType: "Encounter",
status: "finished",
class: "inpatient",
subject: {
reference: "Patient/dd738d54-1691-11df-97a5-7038c432aabf",
display: "Daisylene Ekeno(Identifier:1865TU-8)"
},
participant: [1]
0: {
individual: {
reference: "Practitioner/bf218490-1691-11df-97a5-7038c432aabf",
display: "Super User(Identifier:admin)"
}
}
period: {
start: "2006-02-07T00:00:00",
end: "2006-02-07T00:00:00"
},
location: [1]
0: {
location: {
reference: "Location/8d6c993e-c2cc-11de-8d13-0010c6dffd0f",
display: "Inpatient Ward"
},
period: {
start: "2006-02-07T00:00:00",
end: "2006-02-07T00:00:00"
}
}
}
Available RESTful web services for the Encounter Resource supported by the API
GET Requests
| Search | |
|---|---|
| /ws/fhir/Encounter/{id} | Above request will fetch the Encounter for the given unique uuid. Here id represents, the logical resource id associated with the resource. |
| /ws/fhir/Encounter?_id={id} | Above request will fetch all the Encounter using the given uuid value. This will give a List of Encounter as the response.Here _id parameter represents, the logical resource id associated with the resource. |
| /ws/fhir/Encounter?patient.identifier={identifier} | Above request will fetch all the Encounter using the given patient's identifier. This will give a List of Encounter ( 0..* Encounter ) as the response. Here identifier parameter represents, patient identifier. |
POST Requests
| Operations | |
|---|---|
/ws/fhir/Encounter/$everything With body : <Parameters xmlns="http://hl7.org/fhir"/> | This request will return bundle resource with resources that associate with encounter which associate with given encounter Id |