Encounter
Semantical type
The “class” field of the resource is used to determine the semantical type of the resource. If the field is not present the resource type will be used. Look at the List of registered codes for a complete list of codes registered in MIDATA. Include the required codes into your applications access filter if you need to use this resource.
Resource owner
If the resource contains a subject which is a Patient or Practitioner that user is the owner of the resource. Otherwise the creator of the resource is the owner.
Default value for “subject”
If a resource with no subject field is send to MIDATA, the backend will set the subject to the current user.
Read
Read a single Encounter by id.
Request:
[GET] /fhir/Encounter/<id>
Read specific version
Read a specific version of a single Encounter by id.
Request:
[GET] /fhir/Encounter/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/Encounter/<id>/_history
Search
Search for resources of type Encounter
Request:
[GET] /fhir/Encounter?searchParams
List of supported search parameters:
Supported query parameters:
| Name | Type | Description |
|---|---|---|
| _id | token | The ID of the resource |
| _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| _page | string | |
| account | reference | The set of accounts that may be used for billing for this Encounter |
| appointment | reference | The appointment that scheduled this encounter |
| based-on | reference | The ServiceRequest that initiated this encounter |
| class | token | Classification of patient encounter |
| date | date | A date within the period the Encounter lasted |
| diagnosis | reference | The diagnosis or procedure relevant to the encounter |
| episode-of-care | reference | Episode(s) of care that this encounter should be recorded against |
| identifier | token | Identifier(s) by which this encounter is known |
| length | quantity | Length of encounter in days |
| location | reference | Location the encounter takes place |
| location-period | date | Time period during which the patient was present at the location |
| part-of | reference | Another Encounter this encounter is part of |
| participant | reference | Persons involved in the encounter other than the patient |
| participant-type | token | Role of participant in encounter |
| patient | reference | The patient or group present at the encounter |
| practitioner | reference | Persons involved in the encounter other than the patient |
| reason-code | token | Coded reason the encounter takes place |
| reason-reference | reference | Reason the encounter takes place (reference) |
| service-provider | reference | The organization (facility) responsible for this encounter |
| special-arrangement | token | Wheelchair, translator, stretcher, etc. |
| status | token | planned - arrived - triaged - in-progress - onleave - finished - cancelled + |
| subject | reference | The patient or group present at the encounter |
| type | token | Specific type of encounter |
Create
Create a new resource of type Encounter.
Request:
[POST] /fhir/Encounter
Update
Updates a resource of type Encounter.
Request:
[PUT] /fhir/Encounter/<id>