Guia de Implementação do AnHealth
0.2.0 - CI Build

Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions

Resource Profile: Encounter

Official URL: https://ancode.app/fhir/StructureDefinition/Encounter Version: 0.2.0
Draft as of 2023-08-28 Computable Name: Encounter

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... statusHistory
.... period
..... start 1..1dateTimeStarting time with inclusive boundary
... class 1..1CodingClassification of patient encounter
Binding: EncounterClass (required)
... classHistory
.... class 1..1CodingInPerson| AncodeVideoCall | Telephone | WhatsApp+
Binding: EncounterClass (required)
.... period
..... start 1..1dateTimeStarting time with inclusive boundary
... priority 1..1CodeableConceptIndicates the urgency of the encounter
Binding: BRPrioridade (required)
... participant
.... type 1..1CodeableConceptRole of participant in encounter
Binding: EncounterParticipantTypeMostUsed (required)
.... individual 1..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
... appointment 1..1Reference(Appointment)The appointment that scheduled this encounter
... reasonCode 0..1CodeableConceptCoded reason the encounter takes place
Binding: BRCID10 (required)
... hospitalization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dischargeReason 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/DischargeReason
Binding: BRMotivoEncerramento (required)
.... admitSource 1..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (required)
.... dietPreference 0..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (required)
.... dischargeDisposition 0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (required)
... location
.... status 1..1codeplanned | active | reserved | completed
.... period 1..1PeriodTime period during which the patient was present at the location
..... start 1..1dateTimeStarting time with inclusive boundary
... serviceProvider 1..1Reference(Organization)The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Encounter.classrequiredEncounterClass
Encounter.classHistory.classrequiredEncounterClass
Encounter.typerequiredEncounterType
Encounter.priorityrequiredBRPrioridade
Encounter.participant.typerequiredEncounterParticipantTypeMostUsed
Encounter.reasonCoderequiredBRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
Encounter.hospitalization.admitSourcerequiredAdmitSource
Encounter.hospitalization.dietPreferencerequiredDiet
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... type Σ1..1CodeableConceptSpecific type of encounter
Binding: EncounterType (required)
... priority 1..1CodeableConceptIndicates the urgency of the encounter
Binding: BRPrioridade (required)
... appointment Σ1..1Reference(Appointment)The appointment that scheduled this encounter
... reasonCode Σ0..1CodeableConceptCoded reason the encounter takes place
Binding: BRCID10 (required)
... serviceProvider 1..1Reference(Organization)The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Encounter.statusrequiredEncounterStatus
Encounter.classrequiredEncounterClass
Encounter.typerequiredEncounterType
Encounter.priorityrequiredBRPrioridade
Encounter.reasonCoderequiredBRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)

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.exists() and ('#'+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(uri) = '#').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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!Σ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... 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
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC1..1dateTimeStarting time with inclusive boundary
..... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... class Σ1..1CodingClassification of patient encounter
Binding: EncounterClass (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..1CodingInPerson| AncodeVideoCall | Telephone | WhatsApp+
Binding: EncounterClass (required)
.... period 1..1PeriodThe time that the episode was in the specified class
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC1..1dateTimeStarting time with inclusive boundary
..... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... type Σ1..1CodeableConceptSpecific type of encounter
Binding: EncounterType (required)
... serviceType Σ0..1CodeableConceptSpecific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 1..1CodeableConceptIndicates the urgency of the encounter
Binding: BRPrioridade (required)
... subject Σ0..1Reference(Patient | 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 Σ0..*BackboneElementList 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 Σ1..1CodeableConceptRole of participant in encounter
Binding: EncounterParticipantTypeMostUsed (required)
.... period 0..1PeriodPeriod of time during the encounter that the participant participated
.... individual Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
... appointment Σ1..1Reference(Appointment)The appointment that scheduled this encounter
... period 0..1PeriodThe start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode Σ0..1CodeableConceptCoded reason the encounter takes place
Binding: BRCID10 (required)
... 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
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dischargeReason 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/DischargeReason
Binding: BRMotivoEncerramento (required)
.... 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 1..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (required)
.... 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 (required)
.... 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..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (required)
... 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 1..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 1..1PeriodTime period during which the patient was present at the location
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC1..1dateTimeStarting time with inclusive boundary
..... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... serviceProvider 1..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

Terminology Bindings

PathConformanceValueSet
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classrequiredEncounterClass
Encounter.classHistory.classrequiredEncounterClass
Encounter.typerequiredEncounterType
Encounter.serviceTypeexampleServiceType
Encounter.priorityrequiredBRPrioridade
Encounter.participant.typerequiredEncounterParticipantTypeMostUsed
Encounter.reasonCoderequiredBRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
Encounter.diagnosis.usepreferredDiagnosisRole
Encounter.hospitalization.admitSourcerequiredAdmitSource
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
Encounter.hospitalization.dietPreferencerequiredDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition
Encounter.location.statusrequiredEncounterLocationStatus
Encounter.location.physicalTypeexampleLocationType

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningEncounter.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

This structure is derived from Encounter

Summary

Mandatory: 4 elements (8 nested mandatory elements)

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... statusHistory
.... period
..... start 1..1dateTimeStarting time with inclusive boundary
... class 1..1CodingClassification of patient encounter
Binding: EncounterClass (required)
... classHistory
.... class 1..1CodingInPerson| AncodeVideoCall | Telephone | WhatsApp+
Binding: EncounterClass (required)
.... period
..... start 1..1dateTimeStarting time with inclusive boundary
... priority 1..1CodeableConceptIndicates the urgency of the encounter
Binding: BRPrioridade (required)
... participant
.... type 1..1CodeableConceptRole of participant in encounter
Binding: EncounterParticipantTypeMostUsed (required)
.... individual 1..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
... appointment 1..1Reference(Appointment)The appointment that scheduled this encounter
... reasonCode 0..1CodeableConceptCoded reason the encounter takes place
Binding: BRCID10 (required)
... hospitalization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dischargeReason 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/DischargeReason
Binding: BRMotivoEncerramento (required)
.... admitSource 1..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (required)
.... dietPreference 0..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (required)
.... dischargeDisposition 0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (required)
... location
.... status 1..1codeplanned | active | reserved | completed
.... period 1..1PeriodTime period during which the patient was present at the location
..... start 1..1dateTimeStarting time with inclusive boundary
... serviceProvider 1..1Reference(Organization)The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Encounter.classrequiredEncounterClass
Encounter.classHistory.classrequiredEncounterClass
Encounter.typerequiredEncounterType
Encounter.priorityrequiredBRPrioridade
Encounter.participant.typerequiredEncounterParticipantTypeMostUsed
Encounter.reasonCoderequiredBRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
Encounter.hospitalization.admitSourcerequiredAdmitSource
Encounter.hospitalization.dietPreferencerequiredDiet
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... type Σ1..1CodeableConceptSpecific type of encounter
Binding: EncounterType (required)
... priority 1..1CodeableConceptIndicates the urgency of the encounter
Binding: BRPrioridade (required)
... appointment Σ1..1Reference(Appointment)The appointment that scheduled this encounter
... reasonCode Σ0..1CodeableConceptCoded reason the encounter takes place
Binding: BRCID10 (required)
... serviceProvider 1..1Reference(Organization)The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Encounter.statusrequiredEncounterStatus
Encounter.classrequiredEncounterClass
Encounter.typerequiredEncounterType
Encounter.priorityrequiredBRPrioridade
Encounter.reasonCoderequiredBRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)

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.exists() and ('#'+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(uri) = '#').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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!Σ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... 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
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC1..1dateTimeStarting time with inclusive boundary
..... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... class Σ1..1CodingClassification of patient encounter
Binding: EncounterClass (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..1CodingInPerson| AncodeVideoCall | Telephone | WhatsApp+
Binding: EncounterClass (required)
.... period 1..1PeriodThe time that the episode was in the specified class
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC1..1dateTimeStarting time with inclusive boundary
..... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... type Σ1..1CodeableConceptSpecific type of encounter
Binding: EncounterType (required)
... serviceType Σ0..1CodeableConceptSpecific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 1..1CodeableConceptIndicates the urgency of the encounter
Binding: BRPrioridade (required)
... subject Σ0..1Reference(Patient | 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 Σ0..*BackboneElementList 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 Σ1..1CodeableConceptRole of participant in encounter
Binding: EncounterParticipantTypeMostUsed (required)
.... period 0..1PeriodPeriod of time during the encounter that the participant participated
.... individual Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
... appointment Σ1..1Reference(Appointment)The appointment that scheduled this encounter
... period 0..1PeriodThe start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode Σ0..1CodeableConceptCoded reason the encounter takes place
Binding: BRCID10 (required)
... 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
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dischargeReason 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/DischargeReason
Binding: BRMotivoEncerramento (required)
.... 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 1..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (required)
.... 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 (required)
.... 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..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (required)
... 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 1..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 1..1PeriodTime period during which the patient was present at the location
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC1..1dateTimeStarting time with inclusive boundary
..... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... serviceProvider 1..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

Terminology Bindings

PathConformanceValueSet
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classrequiredEncounterClass
Encounter.classHistory.classrequiredEncounterClass
Encounter.typerequiredEncounterType
Encounter.serviceTypeexampleServiceType
Encounter.priorityrequiredBRPrioridade
Encounter.participant.typerequiredEncounterParticipantTypeMostUsed
Encounter.reasonCoderequiredBRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
Encounter.diagnosis.usepreferredDiagnosisRole
Encounter.hospitalization.admitSourcerequiredAdmitSource
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
Encounter.hospitalization.dietPreferencerequiredDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition
Encounter.location.statusrequiredEncounterLocationStatus
Encounter.location.physicalTypeexampleLocationType

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningEncounter.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

This structure is derived from Encounter

Summary

Mandatory: 4 elements (8 nested mandatory elements)

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron