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
| Official URL: https://ancode.app/fhir/StructureDefinition/Encounter | Version: 0.2.0 | |||
| Draft as of 2023-08-28 | Computable Name: Encounter | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() | ||||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() | 1..1 | Coding | Classification of patient encounter Binding: EncounterClass (required) | |
![]() ![]() | ||||
![]() ![]() ![]() | 1..1 | Coding | InPerson| AncodeVideoCall | Telephone | WhatsApp+ Binding: EncounterClass (required) | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() | 1..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (required) | |
![]() ![]() | 1..1 | CodeableConcept | Indicates the urgency of the encounter Binding: BRPrioridade (required) | |
![]() ![]() | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | Role of participant in encounter Binding: EncounterParticipantTypeMostUsed (required) | |
![]() ![]() ![]() | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
![]() ![]() | 1..1 | Reference(Appointment) | The appointment that scheduled this encounter | |
![]() ![]() | 0..1 | CodeableConcept | Coded reason the encounter takes place Binding: BRCID10 (required) | |
![]() ![]() | ||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/DischargeReason Binding: BRMotivoEncerramento (required) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (required) | |
![]() ![]() ![]() | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (required) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (required) | |
![]() ![]() | ||||
![]() ![]() ![]() | 1..1 | code | planned | active | reserved | completed | |
![]() ![]() ![]() | 1..1 | Period | Time period during which the patient was present at the location | |
![]() ![]() ![]() ![]() | 1..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() | 1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.class | required | EncounterClass |
| Encounter.classHistory.class | required | EncounterClass |
| Encounter.type | required | EncounterType |
| Encounter.priority | required | BRPrioridade |
| Encounter.participant.type | required | EncounterParticipantTypeMostUsed |
| Encounter.reasonCode | required | BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10) |
| Encounter.hospitalization.admitSource | required | AdmitSource |
| Encounter.hospitalization.dietPreference | required | Diet |
| Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition |
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() | Σ | 1..1 | Coding | Classification of patient encounter Binding: EncounterClass (required) |
![]() ![]() | Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (required) |
![]() ![]() | 1..1 | CodeableConcept | Indicates the urgency of the encounter Binding: BRPrioridade (required) | |
![]() ![]() | Σ | 1..1 | Reference(Appointment) | The appointment that scheduled this encounter |
![]() ![]() | Σ | 0..1 | CodeableConcept | Coded reason the encounter takes place Binding: BRCID10 (required) |
![]() ![]() | 1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.status | required | EncounterStatus |
| Encounter.class | required | EncounterClass |
| Encounter.type | required | EncounterType |
| Encounter.priority | required | BRPrioridade |
| Encounter.reasonCode | required | BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If 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-4 | error | Encounter | If 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-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() | 0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() | 1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() | Σ | 1..1 | Coding | Classification of patient encounter Binding: EncounterClass (required) | ||||
![]() ![]() | 0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | Coding | InPerson| AncodeVideoCall | Telephone | WhatsApp+ Binding: EncounterClass (required) | |||||
![]() ![]() ![]() | 1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() | Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (required) | ||||
![]() ![]() | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() | 1..1 | CodeableConcept | Indicates the urgency of the encounter Binding: BRPrioridade (required) | |||||
![]() ![]() | Σ | 0..1 | Reference(Patient | Group) | The patient or group present at the encounter | ||||
![]() ![]() | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() | Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Role of participant in encounter Binding: EncounterParticipantTypeMostUsed (required) | ||||
![]() ![]() ![]() | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() | Σ | 1..1 | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() | 0..1 | Period | The start and end time of the encounter | |||||
![]() ![]() | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() | Σ | 0..1 | CodeableConcept | Coded reason the encounter takes place Binding: BRCID10 (required) | ||||
![]() ![]() | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/DischargeReason Binding: BRMotivoEncerramento (required) | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() | 1..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (required) | |||||
![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (required) | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (required) | |||||
![]() ![]() | 0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() | 1..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() | 1..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() | 1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Encounter.language | preferred | CommonLanguages
| ||||
| Encounter.status | required | EncounterStatus | ||||
| Encounter.statusHistory.status | required | EncounterStatus | ||||
| Encounter.class | required | EncounterClass | ||||
| Encounter.classHistory.class | required | EncounterClass | ||||
| Encounter.type | required | EncounterType | ||||
| Encounter.serviceType | example | ServiceType | ||||
| Encounter.priority | required | BRPrioridade | ||||
| Encounter.participant.type | required | EncounterParticipantTypeMostUsed | ||||
| Encounter.reasonCode | required | BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10) | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRole | ||||
| Encounter.hospitalization.admitSource | required | AdmitSource | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator | ||||
| Encounter.hospitalization.dietPreference | required | Diet | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements | ||||
| Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition | ||||
| Encounter.location.status | required | EncounterLocationStatus | ||||
| Encounter.location.physicalType | example | LocationType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Encounter.contained | Containing 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() | ||||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() | 1..1 | Coding | Classification of patient encounter Binding: EncounterClass (required) | |
![]() ![]() | ||||
![]() ![]() ![]() | 1..1 | Coding | InPerson| AncodeVideoCall | Telephone | WhatsApp+ Binding: EncounterClass (required) | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() | 1..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (required) | |
![]() ![]() | 1..1 | CodeableConcept | Indicates the urgency of the encounter Binding: BRPrioridade (required) | |
![]() ![]() | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | Role of participant in encounter Binding: EncounterParticipantTypeMostUsed (required) | |
![]() ![]() ![]() | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
![]() ![]() | 1..1 | Reference(Appointment) | The appointment that scheduled this encounter | |
![]() ![]() | 0..1 | CodeableConcept | Coded reason the encounter takes place Binding: BRCID10 (required) | |
![]() ![]() | ||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/DischargeReason Binding: BRMotivoEncerramento (required) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (required) | |
![]() ![]() ![]() | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (required) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (required) | |
![]() ![]() | ||||
![]() ![]() ![]() | 1..1 | code | planned | active | reserved | completed | |
![]() ![]() ![]() | 1..1 | Period | Time period during which the patient was present at the location | |
![]() ![]() ![]() ![]() | 1..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() | 1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.class | required | EncounterClass |
| Encounter.classHistory.class | required | EncounterClass |
| Encounter.type | required | EncounterType |
| Encounter.priority | required | BRPrioridade |
| Encounter.participant.type | required | EncounterParticipantTypeMostUsed |
| Encounter.reasonCode | required | BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10) |
| Encounter.hospitalization.admitSource | required | AdmitSource |
| Encounter.hospitalization.dietPreference | required | Diet |
| Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() | Σ | 1..1 | Coding | Classification of patient encounter Binding: EncounterClass (required) |
![]() ![]() | Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (required) |
![]() ![]() | 1..1 | CodeableConcept | Indicates the urgency of the encounter Binding: BRPrioridade (required) | |
![]() ![]() | Σ | 1..1 | Reference(Appointment) | The appointment that scheduled this encounter |
![]() ![]() | Σ | 0..1 | CodeableConcept | Coded reason the encounter takes place Binding: BRCID10 (required) |
![]() ![]() | 1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.status | required | EncounterStatus |
| Encounter.class | required | EncounterClass |
| Encounter.type | required | EncounterType |
| Encounter.priority | required | BRPrioridade |
| Encounter.reasonCode | required | BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If 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-4 | error | Encounter | If 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-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() | 0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() | 1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() | Σ | 1..1 | Coding | Classification of patient encounter Binding: EncounterClass (required) | ||||
![]() ![]() | 0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | Coding | InPerson| AncodeVideoCall | Telephone | WhatsApp+ Binding: EncounterClass (required) | |||||
![]() ![]() ![]() | 1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() | Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (required) | ||||
![]() ![]() | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() | 1..1 | CodeableConcept | Indicates the urgency of the encounter Binding: BRPrioridade (required) | |||||
![]() ![]() | Σ | 0..1 | Reference(Patient | Group) | The patient or group present at the encounter | ||||
![]() ![]() | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() | Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Role of participant in encounter Binding: EncounterParticipantTypeMostUsed (required) | ||||
![]() ![]() ![]() | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() | Σ | 1..1 | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() | 0..1 | Period | The start and end time of the encounter | |||||
![]() ![]() | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() | Σ | 0..1 | CodeableConcept | Coded reason the encounter takes place Binding: BRCID10 (required) | ||||
![]() ![]() | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/DischargeReason Binding: BRMotivoEncerramento (required) | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() | 1..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (required) | |||||
![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (required) | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (required) | |||||
![]() ![]() | 0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() | 1..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() | 1..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() | 1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Encounter.language | preferred | CommonLanguages
| ||||
| Encounter.status | required | EncounterStatus | ||||
| Encounter.statusHistory.status | required | EncounterStatus | ||||
| Encounter.class | required | EncounterClass | ||||
| Encounter.classHistory.class | required | EncounterClass | ||||
| Encounter.type | required | EncounterType | ||||
| Encounter.serviceType | example | ServiceType | ||||
| Encounter.priority | required | BRPrioridade | ||||
| Encounter.participant.type | required | EncounterParticipantTypeMostUsed | ||||
| Encounter.reasonCode | required | BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10) | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRole | ||||
| Encounter.hospitalization.admitSource | required | AdmitSource | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator | ||||
| Encounter.hospitalization.dietPreference | required | Diet | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements | ||||
| Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition | ||||
| Encounter.location.status | required | EncounterLocationStatus | ||||
| Encounter.location.physicalType | example | LocationType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Encounter.contained | Containing 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Other representations of profile: CSV, Excel, Schematron