IE (Ireland) Core Implementation Guide
1.0.0-ballot - Ballot
Publication Build: This will be filled in by the publication tooling
Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-encounter | Version: 1.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: IECoreEncounterProfile | ||
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.22 | ||||
Copyright/Legal: iEHR.ai, all rights reserved Creative Commons License |
The IE Core Encounter Profile inherits from the FHIR Encounter resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Encounter resource to record, search, and fetch basic encounter information for an individual patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
Example Usage Scenarios:
The following are example usage scenarios for this profile:
The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Each Encounter Must Have:
Each Encounter Must Support:
Additional IECDI Requirements:
These Additional IECDI Requirements elements are not Mandatory or Must Support but are required for certification testing and are included in the formal definition of the profile and the Patient examples.
*see guidance below
Profile Specific Implementation Guidance:
encounter-diagnosis
. An example search is shown in the Condition Quick Start section.Encounter.reasonCode
or a reference with Encounter.reasonReference
to Condition or other resources.
Encounter.reasonReference
references an Observation, it SHOULD conform to a IE Core Observation if applicable. For example, a laboratory result SHOULD conform to the IE Core Laboratory Result Observation Profile.Encounter.location.location
or indirectly through the Organization referenced by Encounter.serviceProvider
.
Encounter.location.location
and Encounter.serviceProvider
, but they SHALL support at least one of these elements.If the event facility/location differs from the Encounter.location
, systems SHOULD reference it directly:
location
element for all resources where the element is available.Patient.language
element and the optional Patient Proficiency Extension and infer a patient's language service needs from it.Meta.lastUpdated
SHOULD reflect:
Based upon additional testing, we intend to to upgrade the Meta.lastUpdated
guidance (SHOULD) to requirements (SHALL) in the next version of IE Core
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
meta | S | 0..1 | Meta | Metadata about the resource |
lastUpdated | S | 0..1 | instant | When the resource last changed |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
interpreterRequired | 0..1 | Coding | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns | |
identifier | S | 0..* | Identifier | Identifier(s) by which this encounter is known |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
status | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
class | S | 1..1 | Coding | Classification of patient encounter |
type | S | 1..* | CodeableConcept | Specific type of encounter Binding: IE Core Encounter Type (extensible): Valueset to describe the Encounter Type |
subject | S | 1..1 | Reference(IE Core Patient Profile S | Group) | The patient or group present at the encounter |
participant | S | 0..* | BackboneElement | List of participants involved in the encounter |
type | S | 0..* | CodeableConcept | Role of participant in encounter |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | S | 0..1 | Reference(IE Core Practitioner Profile S | IE Core PractitionerRole Profile | IE Core RelatedPerson Profile) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
reasonCode | S | 0..* | CodeableConcept | Coded reason the encounter takes place |
reasonReference | S | 0..* | Reference(IE Core Condition Problems and Health Concerns Profile S | IE Core Condition Encounter Diagnosis Profile S | IE Core Procedure Profile | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IE Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
location | S | 1..1 | Reference(IE Core Location Profile) | Location the encounter takes place |
serviceProvider | S | 0..1 | Reference(IE Core Organization Profile) | The organization (facility) responsible for this encounter |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.type | extensible | IECoreEncounterTypehttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-encounter-type from this IG | |
Encounter.hospitalization.dischargeDisposition | preferred | IECoreDischargeDispositionhttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-discharge-disposition from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
meta | SΞ£ | 0..1 | Meta | Metadata about the resource |
lastUpdated | SΞ£ | 0..1 | instant | When the resource last changed |
implicitRules | ?!Ξ£ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
interpreterRequired | 0..1 | Coding | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΞ£ | 0..* | Identifier | Identifier(s) by which this encounter is known |
use | ?!Ξ£ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΞ£ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΞ£ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΞ£ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
class | SΞ£ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
type | SΞ£ | 1..* | CodeableConcept | Specific type of encounter Binding: IE Core Encounter Type (extensible): Valueset to describe the Encounter Type |
subject | SΞ£ | 1..1 | Reference(IE Core Patient Profile) | The patient or group present at the encounter |
participant | SΞ£ | 0..* | BackboneElement | List of participants involved in the encounter |
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΞ£ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΞ£ | 0..1 | Reference(IE Core Practitioner Profile) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
reasonCode | SΞ£ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
reasonReference | SΞ£ | 0..* | Reference(IE Core Condition Problems and Health Concerns Profile | IE Core Condition Encounter Diagnosis Profile) | Reason the encounter takes place (reference) |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IE Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | S | 1..1 | Reference(IE Core Location Profile) | Location the encounter takes place |
serviceProvider | S | 0..1 | Reference(IE Core Organization Profile) | The organization (facility) responsible for this encounter |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | extensible | IECoreEncounterTypehttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-encounter-type from this IG | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.hospitalization.dischargeDisposition | preferred | IECoreDischargeDispositionhttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-discharge-disposition from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
id | Ξ£ | 0..1 | id | Logical id of this artifact | ||||
meta | SΞ£ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Ξ£ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΞ£ | 0..1 | instant | When the resource last changed | ||||
source | Ξ£ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Ξ£ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Ξ£ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Ξ£ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Ξ£ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
interpreterRequired | 0..1 | Coding | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΞ£ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Ξ£ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Ξ£ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΞ£ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΞ£ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Ξ£ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Ξ£ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΞ£ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified status | |||||
class | SΞ£ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | SΞ£ | 1..* | CodeableConcept | Specific type of encounter Binding: IE Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
serviceType | Ξ£ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | SΞ£ | 1..1 | Reference(IE Core Patient Profile S | Group) | The patient or group present at the encounter | ||||
episodeOfCare | Ξ£ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
participant | SΞ£ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΞ£ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
individual | SΞ£ | 0..1 | Reference(IE Core Practitioner Profile S | IE Core PractitionerRole Profile | IE Core RelatedPerson Profile) | Persons involved in the encounter other than the patient | ||||
appointment | Ξ£ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
period | S | 0..1 | Period | The start and end time of the encounter | ||||
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
reasonCode | SΞ£ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
reasonReference | SΞ£ | 0..* | Reference(IE Core Condition Problems and Health Concerns Profile S | IE Core Condition Encounter Diagnosis Profile S | IE Core Procedure Profile | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
diagnosis | Ξ£ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
condition | Ξ£ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge β¦) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IE Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 | ||||
location | S | 0..* | BackboneElement | List of locations where the patient has been | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
location | S | 1..1 | Reference(IE Core Location Profile) | Location the encounter takes place | ||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | S | 0..1 | Reference(IE Core Organization Profile) | The organization (facility) responsible for this encounter | ||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | IECoreEncounterTypehttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-encounter-type from this IG | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | preferred | IECoreDischargeDispositionhttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-discharge-disposition from this IG | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
This structure is derived from Encounter
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 21 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 3
Differential View
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
meta | S | 0..1 | Meta | Metadata about the resource |
lastUpdated | S | 0..1 | instant | When the resource last changed |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
interpreterRequired | 0..1 | Coding | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns | |
identifier | S | 0..* | Identifier | Identifier(s) by which this encounter is known |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
status | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
class | S | 1..1 | Coding | Classification of patient encounter |
type | S | 1..* | CodeableConcept | Specific type of encounter Binding: IE Core Encounter Type (extensible): Valueset to describe the Encounter Type |
subject | S | 1..1 | Reference(IE Core Patient Profile S | Group) | The patient or group present at the encounter |
participant | S | 0..* | BackboneElement | List of participants involved in the encounter |
type | S | 0..* | CodeableConcept | Role of participant in encounter |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | S | 0..1 | Reference(IE Core Practitioner Profile S | IE Core PractitionerRole Profile | IE Core RelatedPerson Profile) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
reasonCode | S | 0..* | CodeableConcept | Coded reason the encounter takes place |
reasonReference | S | 0..* | Reference(IE Core Condition Problems and Health Concerns Profile S | IE Core Condition Encounter Diagnosis Profile S | IE Core Procedure Profile | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IE Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
location | S | 1..1 | Reference(IE Core Location Profile) | Location the encounter takes place |
serviceProvider | S | 0..1 | Reference(IE Core Organization Profile) | The organization (facility) responsible for this encounter |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.type | extensible | IECoreEncounterTypehttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-encounter-type from this IG | |
Encounter.hospitalization.dischargeDisposition | preferred | IECoreDischargeDispositionhttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-discharge-disposition from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
meta | SΞ£ | 0..1 | Meta | Metadata about the resource |
lastUpdated | SΞ£ | 0..1 | instant | When the resource last changed |
implicitRules | ?!Ξ£ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
interpreterRequired | 0..1 | Coding | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΞ£ | 0..* | Identifier | Identifier(s) by which this encounter is known |
use | ?!Ξ£ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΞ£ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΞ£ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΞ£ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
class | SΞ£ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
type | SΞ£ | 1..* | CodeableConcept | Specific type of encounter Binding: IE Core Encounter Type (extensible): Valueset to describe the Encounter Type |
subject | SΞ£ | 1..1 | Reference(IE Core Patient Profile) | The patient or group present at the encounter |
participant | SΞ£ | 0..* | BackboneElement | List of participants involved in the encounter |
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΞ£ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΞ£ | 0..1 | Reference(IE Core Practitioner Profile) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
reasonCode | SΞ£ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
reasonReference | SΞ£ | 0..* | Reference(IE Core Condition Problems and Health Concerns Profile | IE Core Condition Encounter Diagnosis Profile) | Reason the encounter takes place (reference) |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IE Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | S | 1..1 | Reference(IE Core Location Profile) | Location the encounter takes place |
serviceProvider | S | 0..1 | Reference(IE Core Organization Profile) | The organization (facility) responsible for this encounter |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | extensible | IECoreEncounterTypehttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-encounter-type from this IG | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.hospitalization.dischargeDisposition | preferred | IECoreDischargeDispositionhttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-discharge-disposition from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
id | Ξ£ | 0..1 | id | Logical id of this artifact | ||||
meta | SΞ£ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Ξ£ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΞ£ | 0..1 | instant | When the resource last changed | ||||
source | Ξ£ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Ξ£ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Ξ£ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Ξ£ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Ξ£ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
interpreterRequired | 0..1 | Coding | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΞ£ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Ξ£ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Ξ£ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΞ£ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΞ£ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Ξ£ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Ξ£ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΞ£ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified status | |||||
class | SΞ£ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | SΞ£ | 1..* | CodeableConcept | Specific type of encounter Binding: IE Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
serviceType | Ξ£ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | SΞ£ | 1..1 | Reference(IE Core Patient Profile S | Group) | The patient or group present at the encounter | ||||
episodeOfCare | Ξ£ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
participant | SΞ£ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΞ£ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
individual | SΞ£ | 0..1 | Reference(IE Core Practitioner Profile S | IE Core PractitionerRole Profile | IE Core RelatedPerson Profile) | Persons involved in the encounter other than the patient | ||||
appointment | Ξ£ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
period | S | 0..1 | Period | The start and end time of the encounter | ||||
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
reasonCode | SΞ£ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
reasonReference | SΞ£ | 0..* | Reference(IE Core Condition Problems and Health Concerns Profile S | IE Core Condition Encounter Diagnosis Profile S | IE Core Procedure Profile | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
diagnosis | Ξ£ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
condition | Ξ£ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge β¦) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IE Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 | ||||
location | S | 0..* | BackboneElement | List of locations where the patient has been | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Ξ£ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
location | S | 1..1 | Reference(IE Core Location Profile) | Location the encounter takes place | ||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | S | 0..1 | Reference(IE Core Organization Profile) | The organization (facility) responsible for this encounter | ||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | IECoreEncounterTypehttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-encounter-type from this IG | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | preferred | IECoreDischargeDispositionhttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-discharge-disposition from this IG | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
This structure is derived from Encounter
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 21 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the IE Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only IE Core Profiles (Profile Only Support) are not required to support these interactions. See the IE Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.
Servers providing access to encounter data SHALL support these IE Core SMART Scopes:
<patient|user|system>/Encounter.rs
The following search parameters and search parameter combinations SHALL be supported:
SHALL support bothΒ read Encounter by id
AND Encounter search using the _id
search parameter:
GET [base]/Encounter/[id]
or GET [base]/Encounter?_id=[id]
Example:
Implementation Notes: Fetches a single Encounter (how to search by the logical id of the resource)
SHALL support searching for all encounters for a patient using the patient
search parameter:
GET [base]/Encounter?patient={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient (how to search by reference)
SHALL support searching using the combination of the date
and patient
search parameters:
date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
)GET [base]/Encounter?date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}&patient={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources matching the specified date and patient (how to search by date and how to search by reference)
The following search parameter combinations SHOULD be supported:
SHOULD support searching for an encounter by an identifier using the identifier
search parameter:
GET [base]/Encounter?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any Encounter resources matching the identifier (how to search by token)
SHOULD support searching using the combination of the class
and patient
search parameters:
GET [base]/Encounter?class={system|}[code]&patient={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources matching the specified class and patient (how to search by reference and how to search by token)
SHOULD support searching using the combination of the patient
and type
search parameters:
GET [base]/Encounter?patient={Type/}[id]&type={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources matching the specified patient and type (how to search by reference and how to search by token)
SHOULD support searching using the combination of the patient
and location
search parameters:
GET [base]/Encounter?patient={Type/}[id]&location={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources matching the specified patient and location (how to search by reference)
SHOULD support searching using the combination of the patient
and status
search parameters:
GET [base]/Encounter?patient={Type/}[id]&status={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources matching the specified patient and status (how to search by reference and how to search by token)
SHOULD support searching using the combination of the patient
and discharge-disposition
search parameters:
GET [base]/Encounter?patient={Type/}[id]&discharge-disposition={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources matching the specified patient and discharge-disposition (how to search by reference and how to search by token)
SHOULD support searching using the combination of the patient
and _lastUpdated
search parameters:
_lastUpdated
comparators: gt,lt,ge,le
_lastUpdated
(e.g._lastUpdated=[date]&_lastUpdated=[date]]&...
)GET [base]/Encounter?patient={Type/}[id]&_lastUpdated={gt|lt|ge|le}[date]{&_lastUpdated={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient and _lastUpdated. See the IE Core General Guidance page for Searching Using lastUpdated. (how to search by reference and how to search by date)