encounters

Create Encounter

post
/organizations/{organizationId}/fhir/3/Encounter

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringEncounterThis is a Encounter resource
identifierarray(Identifier)Identifier(s) by which this encounter is known.
statusstringplanned|arrived|triaged|in-progress|onleave|finished|cancelled|entered-in-error|unknownplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
statusHistoryarray(Encounter_StatusHistory)The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
classCodinginpatient | outpatient | ambulatory | emergency +.
classHistoryarray(Encounter_ClassHistory)The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.
typearray(CodeableConcept)Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
priorityCodeableConceptIndicates the urgency of the encounter.
subjectReferenceThe patient ro group present at the encounter.
episodeOfCarearray(Reference)Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
incomingReferralarray(Reference)The referral request this encounter satisfies (incoming referral).
participantarray(Encounter_Participant)The list of people responsible for providing the service.
appointmentReferenceThe appointment that scheduled this encounter.
periodPeriodThe start and end time of the encounter.
lengthDurationQuantity of time the encounter lasted. This excludes the time during leaves of absence.
reasonarray(CodeableConcept)Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
diagnosisarray(Encounter_Diagnosis)The list of diagnosis relevant to this encounter.
accountarray(Reference)The set of accounts that may be used for billing for this Encounter.
hospitalizationEncounter_HospitalizationDetails about the admission to a healthcare service.
locationarray(Encounter_Location)List of locations where the patient has been during this encounter.
serviceProviderReferenceAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
partOfReferenceAnother Encounter of which this encounter is a part of (administratively or in time).

Response

Patch Encounter

patch
/organizations/{organizationId}/fhir/3/Encounter/{resourceId}

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.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringEncounterThis is a Encounter resource
identifierarray(Identifier)Identifier(s) by which this encounter is known.
statusstringplanned|arrived|triaged|in-progress|onleave|finished|cancelled|entered-in-error|unknownplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
statusHistoryarray(Encounter_StatusHistory)The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
classCodinginpatient | outpatient | ambulatory | emergency +.
classHistoryarray(Encounter_ClassHistory)The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.
typearray(CodeableConcept)Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
priorityCodeableConceptIndicates the urgency of the encounter.
subjectReferenceThe patient ro group present at the encounter.
episodeOfCarearray(Reference)Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
incomingReferralarray(Reference)The referral request this encounter satisfies (incoming referral).
participantarray(Encounter_Participant)The list of people responsible for providing the service.
appointmentReferenceThe appointment that scheduled this encounter.
periodPeriodThe start and end time of the encounter.
lengthDurationQuantity of time the encounter lasted. This excludes the time during leaves of absence.
reasonarray(CodeableConcept)Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
diagnosisarray(Encounter_Diagnosis)The list of diagnosis relevant to this encounter.
accountarray(Reference)The set of accounts that may be used for billing for this Encounter.
hospitalizationEncounter_HospitalizationDetails about the admission to a healthcare service.
locationarray(Encounter_Location)List of locations where the patient has been during this encounter.
serviceProviderReferenceAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
partOfReferenceAnother Encounter of which this encounter is a part of (administratively or in time).

Response

Read Encounter

get
/organizations/{organizationId}/fhir/3/Encounter/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Encounter

get
/organizations/{organizationId}/fhir/3/Encounter/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Encounter

get
/organizations/{organizationId}/fhir/3/Encounter/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Encounter

delete
/organizations/{organizationId}/fhir/3/Encounter/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Encounter

get
/organizations/{organizationId}/fhir/3/Encounter

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
appointmentstring
classstring
datestring
diagnosisstring
episodeofcarestring
identifierstring
incomingreferralstring
lengthstring
locationstring
location-periodstring
part-ofstring
participantstring
participant-typestring
patientstring
practitionerstring
reasonstring
service-providerstring
special-arrangementstring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Encounter

get
/organizations/{organizationId}/fhir/3/Encounter/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Encounter

post
/organizations/{organizationId}/fhir/3/Encounter/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
appointmentstring
classstring
datestring
diagnosisstring
episodeofcarestring
identifierstring
incomingreferralstring
lengthstring
locationstring
location-periodstring
part-ofstring
participantstring
participant-typestring
patientstring
practitionerstring
reasonstring
service-providerstring
special-arrangementstring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringEncounterThis is a Encounter resource
identifierarray(Identifier)Identifier(s) by which this encounter is known.
statusstringplanned|arrived|triaged|in-progress|onleave|finished|cancelled|entered-in-error|unknownplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
statusHistoryarray(Encounter_StatusHistory)The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
classCodinginpatient | outpatient | ambulatory | emergency +.
classHistoryarray(Encounter_ClassHistory)The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.
typearray(CodeableConcept)Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
priorityCodeableConceptIndicates the urgency of the encounter.
subjectReferenceThe patient ro group present at the encounter.
episodeOfCarearray(Reference)Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
incomingReferralarray(Reference)The referral request this encounter satisfies (incoming referral).
participantarray(Encounter_Participant)The list of people responsible for providing the service.
appointmentReferenceThe appointment that scheduled this encounter.
periodPeriodThe start and end time of the encounter.
lengthDurationQuantity of time the encounter lasted. This excludes the time during leaves of absence.
reasonarray(CodeableConcept)Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
diagnosisarray(Encounter_Diagnosis)The list of diagnosis relevant to this encounter.
accountarray(Reference)The set of accounts that may be used for billing for this Encounter.
hospitalizationEncounter_HospitalizationDetails about the admission to a healthcare service.
locationarray(Encounter_Location)List of locations where the patient has been during this encounter.
serviceProviderReferenceAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
partOfReferenceAnother Encounter of which this encounter is a part of (administratively or in time).

Response

Update Encounter

put
/organizations/{organizationId}/fhir/3/Encounter/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringEncounterThis is a Encounter resource
identifierarray(Identifier)Identifier(s) by which this encounter is known.
statusstringplanned|arrived|triaged|in-progress|onleave|finished|cancelled|entered-in-error|unknownplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
statusHistoryarray(Encounter_StatusHistory)The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
classCodinginpatient | outpatient | ambulatory | emergency +.
classHistoryarray(Encounter_ClassHistory)The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.
typearray(CodeableConcept)Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
priorityCodeableConceptIndicates the urgency of the encounter.
subjectReferenceThe patient ro group present at the encounter.
episodeOfCarearray(Reference)Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
incomingReferralarray(Reference)The referral request this encounter satisfies (incoming referral).
participantarray(Encounter_Participant)The list of people responsible for providing the service.
appointmentReferenceThe appointment that scheduled this encounter.
periodPeriodThe start and end time of the encounter.
lengthDurationQuantity of time the encounter lasted. This excludes the time during leaves of absence.
reasonarray(CodeableConcept)Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
diagnosisarray(Encounter_Diagnosis)The list of diagnosis relevant to this encounter.
accountarray(Reference)The set of accounts that may be used for billing for this Encounter.
hospitalizationEncounter_HospitalizationDetails about the admission to a healthcare service.
locationarray(Encounter_Location)List of locations where the patient has been during this encounter.
serviceProviderReferenceAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
partOfReferenceAnother Encounter of which this encounter is a part of (administratively or in time).

Response