Create an encounter
post
/Encounter
Creates an individual encounter.
Authorization Types
This operation supports the following authorization types:
Request
Supported Media Types
- application/json+fhir
Header Parameters
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.
-
accept(required): string
The media type to be requested. See what the resource's operation produces for what is supported.
-
content-type(required): string
Specifies the content type of the request entity body.
The body of the create operation
Root Schema : EncounterCreateBody
Type:
Show Source
object
-
class:
string
The classification of the encounter. Direct writing of class is not supported. This field is inferred on a write.Example:
inpatient
-
extension:
A client-defined custom attribute for the encounter.
Note:- The custom-attribute ID field cannot be set.
- custom-attribute-name and custom-attribute-value are both required.
- ID and valueString for custom-attribute-name are required.
- custom-attribute-value can be of type string, integer, dateTime, or CodeableConcept.
- CodeableConcept can have the following systems:
- https://fhir.cerner.com/{EHR source id}/nomenclature
- https://fhir.cerner.com/{EHR source id}/codeSet/{code set}
Example:[ { "extension": [ { "id": "ENCNTR:2822522", "valueString": "ICD-9 Code", "url": "custom-attribute-name" }, { "valueString": "test string", "url": "custom-attribute-value" } ], "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute" } ]
-
hospitalization:
object hospitalization
The details about the admission to a healthcare service. Only the admitSource and dischargeDisposition fields are supported on a write.
-
identifier:
object identifier
The identifiers by which this encounter is known.
-
location(required):
The location where the encounter takes place. Only one location reference is permitted. Cannot be provided when serviceProvider is present.Example:
[ { "location": { "reference": "Location/21250409" } } ]
-
meta:
The security labels applied to this resource. Encounters created with meta.security that are set with a code value of
UNCERTREL
are returned with an external encounter type.Example:[ { "security": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationValue", "code": "UNCERTREL" } ] } ]
-
participant:
object participant
The list of people responsible for providing the service.
-
period:
The start and end times of the encounter. A date with the time must be provided.Example:
{ "start": "2020-03-02T01:13:00Z", "end": "2020-03-05T00:00:00Z" }
-
priority:
Identification of the condition, problem, or diagnosis.Example:
[ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ActPriority", "code": "O" } ] } ]
-
reasonCode:
The reason that the encounter is taking place. ICD-10 and SNOMED codes with text fields are supported.Example:
[ { "coding": [ { "system": "http://snomed.info/sct", "code": "208388003", "display": "Fracture At Wrist And/Or Hand Level", "userSelected": true } ] }, { "text": "Neck pain" } ]
-
resourceType(required):
string
The FHIR resource type.
resourceType
must beEncounter
.Example:Encounter
-
serviceProvider(required):
The organization (facility) responsible for this encounter. Cannot be provided when location is present.Example:
{ "reference": "Organization/619848" }
-
status(required):
string
The status of the encounter. Currently, the
cancelled
orentered-in-error
statuses are not supported.Example:in-progress
-
subject:
The patient present at the encounter.Example:
{ "reference": "Patient/4342011" }
-
type:
The specific type of encounter.Example:
[ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0004", "code": "O" } ] } ]
Nested Schema : hospitalization
Type:
object
The details about the admission to a healthcare service. Only the admitSource and dischargeDisposition fields are supported on a write.
Show Source
-
admitSource:
Where the patient was admitted from.
-
dischargeDisposition:
The category or type of location after discharge.
Example:
{
"admitSource": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/admit-source",
"code": "born"
}
]
},
"dischargeDisposition": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",
"code": "other-hcf"
}
]
}
}
Nested Schema : identifier
Type:
object
The identifiers by which this encounter is known.
Show Source
-
period:
The time period during which the identifier is valid for use.Example:
{ "start": "2017-01-17T20:39:40.000Z" }
-
system(required):
string
The namespace of the identifier.Example:
urn:oid:3.3.3.3.3.3
-
type(required):
object type
The type for the identifier that can be used to determine which identifier is appropriate for a specific purpose.
-
value(required):
string
The unique value of the identifierExample:
2009
Example:
[
{
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/319",
"code": "1077",
"display": "FIN NBR"
}
]
},
"system": "urn:oid:3.3.3.3.3.3",
"value": "2009",
"period": {
"start": "2017-01-17T20:39:40.000Z"
}
}
]
Nested Schema : participant
Type:
object
The list of people responsible for providing the service.
Show Source
-
individual(required):
The personnel present at the encounter.
-
period:
The start and end times for the period when the participant was involved in the encounter.
-
type(required):
The role of the participant in the encounter.
Example:
[
{
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "ATND"
}
]
}
],
"period": {
"start": "2017-03-02T20:01:13.000Z"
},
"individual": {
"reference": "Practitioner/1912007"
}
}
]
Nested Schema : type
Type:
object
The type for the identifier that can be used to determine which identifier is appropriate for a specific purpose.
Example:
{
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/319",
"code": "1077",
"display": "FIN NBR"
}
]
}
}
Response
Supported Media Types
- application/json+fhir
201 Response
Example Request:
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Encounter
Example Request Body:
{
"resourceType": "Encounter",
"status": "in-progress",
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0004",
"code": "O"
}
]
}
],
"priority": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActPriority",
"code": "EL"
}
]
},
"subject": {
"reference": "Patient/12724066"
},
"reasonCode": [
{
"text": "Neck Pain"
}
],
"hospitalization": {
"admitSource": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/admit-source",
"code": "born"
}
]
},
"dischargeDisposition": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",
"code": "other-hcf"
}
]
}
},
"serviceProvider": {
"reference": "Organization/675844"
},
"period": {
"start": "2020-03-02T01:13:00Z",
"end": "2020-03-05T00:00:00Z"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/333",
"code": "1119"
}
]
}
],
"period": {
"start": "2020-03-02T20:01:13.000Z"
},
"individual": {
"reference": "Practitioner/4122622"
}
}
],
"extension": [
{
"extension": [
{
"id": "ENCNTR:2822522",
"valueString": "ICD-9 Code",
"url": "custom-attribute-name"
},
{
"valueString": "test string",
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
},
{
"extension": [
{
"id": "ENCNTR:4047481",
"valueString": "Conversation",
"url": "custom-attribute-name"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/100040",
"code": "4630114",
"display": "Register Patient",
"userSelected": true
}
],
"text": "Register Patient"
},
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
},
{
"extension": [
{
"id": "ENCNTR:970558313",
"valueString": "Gestational AGE",
"url": "custom-attribute-name"
},
{
"valueInteger": 255,
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
},
{
"extension": [
{
"id": "ENCNTR:3339152",
"valueString": "Self-Pay Follow Up Date",
"url": "custom-attribute-name"
},
{
"valueDateTime": "2020-07-03T12:00:00.000Z",
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
}
]
}
Example Response:
Cache-Control: no-cache
Content-Length: 0
Content-Type: application/fhir+json
Date: Wed, 27 Mar 2019 15:59:33 GMT
Etag: W/"0"
Last-Modified: Wed, 27 Mar 2019 15:59:30 GMT
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Encounter/1621910
Vary: Origin
X-Request-Id: 11111111111111111111111111111111
The ETag response header includes the current If-Match version to use on a subsequent update.