WebDocFhirApi Implementation Guide CI Build

StructureDefinition-wd-encounter

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://fhir.atlan.se/StructureDefinition/WebDocEncounter

Published on Wed Feb 03 10:42:24 CET 2021 as a draft by .

This profile builds on Encounter


Summary

Must-Support: 20 elements
Fixed Value: 2 elements
Prohibited: 16 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter S
... status SFixed Value: planned
... statusHistory S..0
... classHistory S..0
... type SBinding: https://fhir.atlan.se/ValueSet/visit-type (preferred)
... serviceType S..0
... priority S..0
... episodeOfCare S..0
... basedOn S..0
... participant S..1
... appointment S..0
... length S..0
... reasonCode S..0
... reasonReference S..0
... diagnosis S..0
... account S..0
... hospitalization S..0
... location S..0
... serviceProvider S..0
... partOf S..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter SI0..*An interaction during which services are provided to the patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... id ΣI0..1idLogical id of this artifact
ele-1: All FHIR elements must have a @value or children
... meta ΣI0..1MetaMetadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
ele-1: All FHIR elements must have a @value or children
... text I0..1NarrativeText summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier ΣI0..*IdentifierIdentifier(s) by which this encounter is known
ele-1: All FHIR elements must have a @value or children
... status ?!SΣI1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
ele-1: All FHIR elements must have a @value or children

Fixed Value: planned
... class ΣI1..1CodingClassification of patient encounter
Binding: V3 Value SetActEncounterCode (extensible)
ele-1: All FHIR elements must have a @value or children
... type SΣI0..*CodeableConceptSpecific type of encounter
Binding: https://fhir.atlan.se/ValueSet/visit-type (preferred)
ele-1: All FHIR elements must have a @value or children
... subject ΣI0..1Reference(Patient | Group)The patient or group present at the encounter
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... participant SΣI0..1BackboneElementList of participants involved in the encounter
ele-1: All FHIR elements must have a @value or children
.... id 0..1Unique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type ΣI0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible)
ele-1: All FHIR elements must have a @value or children
.... period I0..1PeriodPeriod of time during the encounter that the participant participated
ele-1: All FHIR elements must have a @value or children
per-1: If present, start SHALL have a lower value than end
.... individual ΣI0..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
..... id 0..1Unique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
..... type SΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
ele-1: All FHIR elements must have a @value or children

Fixed Value: PractitionerRole
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
..... display ΣI0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children
... period I0..1PeriodThe start and end time of the encounter
ele-1: All FHIR elements must have a @value or children
per-1: If present, start SHALL have a lower value than end

doco Documentation for this format

Summary

Must-Support: 20 elements
Fixed Value: 2 elements
Prohibited: 16 elements

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter S
... status SFixed Value: planned
... statusHistory S..0
... classHistory S..0
... type SBinding: https://fhir.atlan.se/ValueSet/visit-type (preferred)
... serviceType S..0
... priority S..0
... episodeOfCare S..0
... basedOn S..0
... participant S..1
... appointment S..0
... length S..0
... reasonCode S..0
... reasonReference S..0
... diagnosis S..0
... account S..0
... hospitalization S..0
... location S..0
... serviceProvider S..0
... partOf S..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter SI0..*An interaction during which services are provided to the patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... id ΣI0..1idLogical id of this artifact
ele-1: All FHIR elements must have a @value or children
... meta ΣI0..1MetaMetadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
ele-1: All FHIR elements must have a @value or children
... text I0..1NarrativeText summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier ΣI0..*IdentifierIdentifier(s) by which this encounter is known
ele-1: All FHIR elements must have a @value or children
... status ?!SΣI1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
ele-1: All FHIR elements must have a @value or children

Fixed Value: planned
... class ΣI1..1CodingClassification of patient encounter
Binding: V3 Value SetActEncounterCode (extensible)
ele-1: All FHIR elements must have a @value or children
... type SΣI0..*CodeableConceptSpecific type of encounter
Binding: https://fhir.atlan.se/ValueSet/visit-type (preferred)
ele-1: All FHIR elements must have a @value or children
... subject ΣI0..1Reference(Patient | Group)The patient or group present at the encounter
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... participant SΣI0..1BackboneElementList of participants involved in the encounter
ele-1: All FHIR elements must have a @value or children
.... id 0..1Unique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type ΣI0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible)
ele-1: All FHIR elements must have a @value or children
.... period I0..1PeriodPeriod of time during the encounter that the participant participated
ele-1: All FHIR elements must have a @value or children
per-1: If present, start SHALL have a lower value than end
.... individual ΣI0..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
..... id 0..1Unique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
..... type SΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
ele-1: All FHIR elements must have a @value or children

Fixed Value: PractitionerRole
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
..... display ΣI0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children
... period I0..1PeriodThe start and end time of the encounter
ele-1: All FHIR elements must have a @value or children
per-1: If present, start SHALL have a lower value than end

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron