MediRecords FHIR Implementation Guide
1.4.0 - release


Resource Profile: MR Encounter

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-encounter-core
Version:1.4.0
Name:MREncounter
Title:MR Encounter
Status:Active as of 2024-06-28 01:25:00+0000
Definition:

MediRecords core Encounter profile to record visit related details for a patient in context. This includes details on venue, encounter start and finish time, reason for encounter, type and participating practitioner.

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://fhir.medirecords.com/StructureDefinition/mr-encounter-core

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AUBaseEncounter

Summary

Mandatory: 7 elements (1 nested mandatory element)
Must-Support: 14 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Encounter.participant is sliced based on the value of pattern:type

This structure is derived from AUBaseEncounter

NameFlagsCard.TypeDescription & Constraintsdoco
​.. Encounter C0..*AUBaseEncounterAn encounter in an Australian healthcare context
inv-mr-consult-period-end-01: Medirecords supports period.end for only 'finished' consultation status
inv-mr-consult-period-end-02: Medirecords expects period.end value if the consultation status is set to 'finished'
​... meta 0..1MRMetaMetadata about a resource
​.... lastUpdated S0..1instantWhen the resource version last changed
​.... security S0..*CodingSecurity Labels applied to this resource
​... status SC1..1codein-progress | finished
inv-mr-consult-status-01: Medirecords only supports 'in-progress' or 'finished' status
​... class S1..1CodingGeneral consultation type, e.g. Inpatient, Outpatient, Virtual, etc
Binding: MediRecords Encounter Class ValueSet (required)
​.... coding 0..1CodingCoded consultation type
​.... text 0..1stringConsultation type text
​... subject S1..1Reference(MR Patient)The patient or group present at the encounter
​... episodeOfCare S0..*Reference(MR EpisodeOfCare)Cases the Encounter is linked to
​.... reference 1..1stringRelative reference to EpisodeOfCare representing the case
​... Slices for participant 1..*BackboneElementThis is about the participant who is the performer
Slice: Unordered, Open by pattern:type
​.... participant:performer S1..1BackboneElementList of participants involved in the encounter
​..... type S1..*CodeableConceptRole of participant in encounter
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PPRF
​..... individual S1..1Reference(MR Practitioner)Persons involved in the encounter other than the patient
​... period 1..1PeriodThe start and end time of the encounter
​.... start S0..1dateTimeStarting time with inclusive boundary
​.... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing
​... reasonCode S0..*CodeableConceptCoded reason the encounter takes place
​... serviceProvider S1..1Reference(Organization)The organization (facility) responsible for this encounter

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C0..*AUBaseEncounterAn encounter in an Australian healthcare context
inv-mr-consult-period-end-01: Medirecords supports period.end for only 'finished' consultation status
inv-mr-consult-period-end-02: Medirecords expects period.end value if the consultation status is set to 'finished'
... id Σ0..1idLogical id of this artifact
... meta 0..1MRMetaMetadata about a resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security SΣC0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-mr-meta-security-01: Medirecords supports only U, R security code
.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounterDescription 0..1stringDescription, overview or summary of an encounter
URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
... associatedHealthcareService 0..*Reference(HealthcareService)Associated healthcare service
URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!SΣC1..1codein-progress | finished
Binding: EncounterStatus (required): Current state of the encounter.


inv-mr-consult-status-01: Medirecords only supports 'in-progress' or 'finished' status
... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status 1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified status
... class SΣ1..1CodingGeneral consultation type, e.g. Inpatient, Outpatient, Virtual, etc
Binding: MediRecords Encounter Class ValueSet (required)
... classHistory 0..*BackboneElementList of past encounter classes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... class 1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified class
... type SΣ0..1CodeableConceptSpecific consultation type
Binding: Encounter Type . (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCoded consultation type
.... text Σ0..1stringConsultation type text
... serviceType Σ0..1CodeableConceptSpecific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

... subject SΣ1..1Reference(MR Patient)The patient or group present at the encounter
... episodeOfCare SΣ0..*Reference(MR EpisodeOfCare)Cases the Encounter is linked to
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringRelative reference to EpisodeOfCare representing the case
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... basedOn 0..*Reference(ServiceRequest)The ServiceRequest that initiated this encounter
... Slices for participant Σ1..*BackboneElementThis is about the participant who is the performer
Slice: Unordered, Open by pattern:type
.... participant:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


..... period 0..1PeriodPeriod of time during the encounter that the participant participated
..... individual Σ0..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
.... participant:performer SΣ1..1BackboneElementList of participants involved in the encounter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.



Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PPRF
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... period 0..1PeriodPeriod of time during the encounter that the participant participated
..... individual SΣ1..1Reference(MR Practitioner)Persons involved in the encounter other than the patient
... appointment Σ0..*Reference(Appointment)The appointment that scheduled this encounter
... period 1..1PeriodThe start and end time of the encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode SΣ0..*CodeableConceptCoded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference Σ0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)Reason the encounter takes place (reference)
... diagnosis Σ0..*BackboneElementThe list of diagnosis relevant to this encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition Σ1..1Reference(Condition | Procedure)The diagnosis or procedure relevant to the encounter
.... use 0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank 0..1positiveIntRanking 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 0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(Location | Organization)The location/organization from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1CodeableConceptThe 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..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


.... specialCourtesy 0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.


.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


.... destination 0..1Reference(Location | Organization)Location/organization to which the patient is discharged
.... dischargeDisposition 0..1CodeableConceptSeparation Mode
Binding: Separation Mode . (extensible)
... location 0..*BackboneElementList of locations where the patient has been
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location 1..1Reference(Location)Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

.... physicalType 0..1CodeableConceptThe 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..1PeriodTime period during which the patient was present at the location
... serviceProvider S1..1Reference(Organization)The organization (facility) responsible for this encounter
... partOf 0..1Reference(Encounter)Another Encounter this encounter is part of

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
​.. Encounter 0..*AUBaseEncounterAn encounter in an Australian healthcare context
​... meta 0..1MRMetaMetadata about a resource
​.... lastUpdated Σ0..1instantWhen the resource version last changed
​.... security ΣC0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-mr-meta-security-01: Medirecords supports only U, R security code
​... status ?!ΣC1..1codein-progress | finished
Binding: EncounterStatus (required): Current state of the encounter.


inv-mr-consult-status-01: Medirecords only supports 'in-progress' or 'finished' status
​... class Σ1..1CodingGeneral consultation type, e.g. Inpatient, Outpatient, Virtual, etc
Binding: MediRecords Encounter Class ValueSet (required)
​... subject Σ1..1Reference(MR Patient)The patient or group present at the encounter
​... episodeOfCare Σ0..*Reference(MR EpisodeOfCare)Cases the Encounter is linked to
​... participant:performer Σ1..1BackboneElementList of participants involved in the encounter
​.... type Σ1..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: PPRF
​.... individual Σ1..1Reference(MR Practitioner)Persons involved in the encounter other than the patient
​... period 1..1PeriodThe start and end time of the encounter
​.... start ΣC0..1dateTimeStarting time with inclusive boundary
​.... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
​... reasonCode Σ0..*CodeableConceptCoded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


​... serviceProvider 1..1Reference(Organization)The organization (facility) responsible for this encounter

doco Documentation for this format

This structure is derived from AUBaseEncounter

Summary

Mandatory: 7 elements (1 nested mandatory element)
Must-Support: 14 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Encounter.participant is sliced based on the value of pattern:type

Differential View

This structure is derived from AUBaseEncounter

NameFlagsCard.TypeDescription & Constraintsdoco
​.. Encounter C0..*AUBaseEncounterAn encounter in an Australian healthcare context
inv-mr-consult-period-end-01: Medirecords supports period.end for only 'finished' consultation status
inv-mr-consult-period-end-02: Medirecords expects period.end value if the consultation status is set to 'finished'
​... meta 0..1MRMetaMetadata about a resource
​.... lastUpdated S0..1instantWhen the resource version last changed
​.... security S0..*CodingSecurity Labels applied to this resource
​... status SC1..1codein-progress | finished
inv-mr-consult-status-01: Medirecords only supports 'in-progress' or 'finished' status
​... class S1..1CodingGeneral consultation type, e.g. Inpatient, Outpatient, Virtual, etc
Binding: MediRecords Encounter Class ValueSet (required)
​.... coding 0..1CodingCoded consultation type
​.... text 0..1stringConsultation type text
​... subject S1..1Reference(MR Patient)The patient or group present at the encounter
​... episodeOfCare S0..*Reference(MR EpisodeOfCare)Cases the Encounter is linked to
​.... reference 1..1stringRelative reference to EpisodeOfCare representing the case
​... Slices for participant 1..*BackboneElementThis is about the participant who is the performer
Slice: Unordered, Open by pattern:type
​.... participant:performer S1..1BackboneElementList of participants involved in the encounter
​..... type S1..*CodeableConceptRole of participant in encounter
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PPRF
​..... individual S1..1Reference(MR Practitioner)Persons involved in the encounter other than the patient
​... period 1..1PeriodThe start and end time of the encounter
​.... start S0..1dateTimeStarting time with inclusive boundary
​.... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing
​... reasonCode S0..*CodeableConceptCoded reason the encounter takes place
​... serviceProvider S1..1Reference(Organization)The organization (facility) responsible for this encounter

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C0..*AUBaseEncounterAn encounter in an Australian healthcare context
inv-mr-consult-period-end-01: Medirecords supports period.end for only 'finished' consultation status
inv-mr-consult-period-end-02: Medirecords expects period.end value if the consultation status is set to 'finished'
... id Σ0..1idLogical id of this artifact
... meta 0..1MRMetaMetadata about a resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security SΣC0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-mr-meta-security-01: Medirecords supports only U, R security code
.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounterDescription 0..1stringDescription, overview or summary of an encounter
URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
... associatedHealthcareService 0..*Reference(HealthcareService)Associated healthcare service
URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!SΣC1..1codein-progress | finished
Binding: EncounterStatus (required): Current state of the encounter.


inv-mr-consult-status-01: Medirecords only supports 'in-progress' or 'finished' status
... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status 1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified status
... class SΣ1..1CodingGeneral consultation type, e.g. Inpatient, Outpatient, Virtual, etc
Binding: MediRecords Encounter Class ValueSet (required)
... classHistory 0..*BackboneElementList of past encounter classes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... class 1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified class
... type SΣ0..1CodeableConceptSpecific consultation type
Binding: Encounter Type . (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCoded consultation type
.... text Σ0..1stringConsultation type text
... serviceType Σ0..1CodeableConceptSpecific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

... subject SΣ1..1Reference(MR Patient)The patient or group present at the encounter
... episodeOfCare SΣ0..*Reference(MR EpisodeOfCare)Cases the Encounter is linked to
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringRelative reference to EpisodeOfCare representing the case
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... basedOn 0..*Reference(ServiceRequest)The ServiceRequest that initiated this encounter
... Slices for participant Σ1..*BackboneElementThis is about the participant who is the performer
Slice: Unordered, Open by pattern:type
.... participant:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


..... period 0..1PeriodPeriod of time during the encounter that the participant participated
..... individual Σ0..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
.... participant:performer SΣ1..1BackboneElementList of participants involved in the encounter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.



Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PPRF
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... period 0..1PeriodPeriod of time during the encounter that the participant participated
..... individual SΣ1..1Reference(MR Practitioner)Persons involved in the encounter other than the patient
... appointment Σ0..*Reference(Appointment)The appointment that scheduled this encounter
... period 1..1PeriodThe start and end time of the encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode SΣ0..*CodeableConceptCoded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference Σ0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)Reason the encounter takes place (reference)
... diagnosis Σ0..*BackboneElementThe list of diagnosis relevant to this encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition Σ1..1Reference(Condition | Procedure)The diagnosis or procedure relevant to the encounter
.... use 0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank 0..1positiveIntRanking 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 0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(Location | Organization)The location/organization from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1CodeableConceptThe 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..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


.... specialCourtesy 0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.


.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


.... destination 0..1Reference(Location | Organization)Location/organization to which the patient is discharged
.... dischargeDisposition 0..1CodeableConceptSeparation Mode
Binding: Separation Mode . (extensible)
... location 0..*BackboneElementList of locations where the patient has been
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location 1..1Reference(Location)Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

.... physicalType 0..1CodeableConceptThe 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..1PeriodTime period during which the patient was present at the location
... serviceProvider S1..1Reference(Organization)The organization (facility) responsible for this encounter
... partOf 0..1Reference(Encounter)Another Encounter this encounter is part of

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Encounter.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classrequiredMREncounterClassValueSet
https://fhir.medirecords.com/ValueSet/mr-encounter-class-code
from this IG
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeextensibleEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.episodeOfCare.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.participant:performer.typeextensiblePattern: PPRF
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleSeparationMode . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)
https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-mr-consult-period-end-01errorEncounterMedirecords supports period.end for only 'finished' consultation status
: period.end.exists() implies (status = 'finished')
inv-mr-consult-period-end-02errorEncounterMedirecords expects period.end value if the consultation status is set to 'finished'
: status = 'finished' implies (period.end.exists())
inv-mr-consult-status-01errorEncounter.statusMedirecords only supports 'in-progress' or 'finished' status
: $this.exists() implies ($this = 'in-progress' or $this = 'finished')
inv-mr-meta-security-01errorEncounter.meta.securityMedirecords supports only U, R security code
: code.exists() implies (code = 'U' or code = 'R')