Genomics Clinical Picture Repository Implementation Guide
0.1.0 - ci-build

Genomics Clinical Picture Repository Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: Genomics Clinical Picture Repository Encounter

Official URL: http://aehrc.github.io/genclipr-fhir-ig/StructureDefinition/GencliprEncounter Version: 0.1.0
Active as of 2022-03-21 Computable Name: GencliprEncounter

Copyright/Legal: Australian Genomics

An encounter stored in the repository.

Formal Views of Profile Content

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

This structure is derived from Encounter

Summary

Mandatory: 1 element
Must-Support: 3 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-researchStudy S0..1Reference(ResearchStudy)Associated research study
URL: http://hl7.org/fhir/StructureDefinition/workflow-researchStudy
... encounter-associatedEncounter S0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... type S0..*CodeableConceptSpecific type of encounter
Binding: Encounter Type Value Set (example)
... subject 1..1Reference(Deidentified Patient)The patient or group present at the encounter
... participant 0..0
... appointment 0..0
... account 0..0
... hospitalization 0..0
... location 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... 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
... workflow-researchStudy S0..1Reference(ResearchStudy)Associated research study
URL: http://hl7.org/fhir/StructureDefinition/workflow-researchStudy
... encounter-associatedEncounter S0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... 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
... class Σ1..1CodingClassification of patient encounter
Binding: Encounter Class Value Set (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..*CodeableConceptSpecific type of encounter
Binding: Encounter Type Value Set (example)
... 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 Σ1..1Reference(Deidentified Patient)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
... period 0..1PeriodThe start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode Σ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)
... serviceProvider 0..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

This structure is derived from Encounter

Summary

Mandatory: 1 element
Must-Support: 3 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-researchStudy S0..1Reference(ResearchStudy)Associated research study
URL: http://hl7.org/fhir/StructureDefinition/workflow-researchStudy
... encounter-associatedEncounter S0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... type S0..*CodeableConceptSpecific type of encounter
Binding: Encounter Type Value Set (example)
... subject 1..1Reference(Deidentified Patient)The patient or group present at the encounter
... participant 0..0
... appointment 0..0
... account 0..0
... hospitalization 0..0
... location 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... 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
... workflow-researchStudy S0..1Reference(ResearchStudy)Associated research study
URL: http://hl7.org/fhir/StructureDefinition/workflow-researchStudy
... encounter-associatedEncounter S0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... 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
... class Σ1..1CodingClassification of patient encounter
Binding: Encounter Class Value Set (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..*CodeableConceptSpecific type of encounter
Binding: Encounter Type Value Set (example)
... 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 Σ1..1Reference(Deidentified Patient)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
... period 0..1PeriodThe start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode Σ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)
... serviceProvider 0..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
Encounter.languagepreferredCommonLanguages
Max Binding: AllLanguages
Encounter.statusrequiredEncounterStatus
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classrequiredEncounterClasses
Encounter.classHistory.classextensibleActEncounterCode
Encounter.typeexampleEncounterTypes
Encounter.serviceTypeexampleServiceType
Encounter.priorityexampleActPriority
Encounter.participant.typeextensibleParticipantType
Encounter.reasonCodepreferredEncounterReasonCodes
Encounter.diagnosis.usepreferredDiagnosisRole
Encounter.hospitalization.admitSourcepreferredAdmitSource
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
Encounter.hospitalization.dietPreferenceexampleDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
Encounter.location.statusrequiredEncounterLocationStatus
Encounter.location.physicalTypeexampleLocationType

Constraints

IdGradePathDetailsRequirements
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-1errorEncounter.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.extension:researchStudyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.extension:researchStudyMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.extension:associatedEncounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.extension:associatedEncounterMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.statusHistoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.statusHistory.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.statusHistory.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.statusHistory.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.statusHistory.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.statusHistory.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.statusHistory.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.classAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.classHistoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.classHistory.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.classHistory.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.classHistory.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.classHistory.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.classHistory.classAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.classHistory.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.serviceTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.episodeOfCareAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.participant.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.participant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.participant.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.participant.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.participant.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.participant.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.participant.individualAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.lengthAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.diagnosisAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.diagnosis.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.diagnosis.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.diagnosis.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.diagnosis.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.diagnosis.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.diagnosis.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.diagnosis.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.hospitalization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.hospitalization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.hospitalization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.hospitalization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.hospitalization.preAdmissionIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.hospitalization.originAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.hospitalization.admitSourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.hospitalization.reAdmissionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.hospitalization.dietPreferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.hospitalization.specialCourtesyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.hospitalization.specialArrangementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.hospitalization.destinationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.hospitalization.dischargeDispositionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.location.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.location.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.location.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.location.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEncounter.location.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.location.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.location.physicalTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.location.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.serviceProviderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEncounter.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())