HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1.1 (Standard for Trial Use)

HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1.1 (Standard for Trial Use) - Local Development build (v1.1.0). See the Directory of published versions

EncounterOrEpisode

 

The official URL for this profile is:

http://hl7.org/fhir/us/odh/StructureDefinition/obf-EncounterOrEpisode

Abstract element representing a group of services delivered to a patient.

This profile builds on DomainResource.

This profile was published on Wed Sep 04 00:00:00 EDT 2019 as a active by HL7 International Public Health Work Group.

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.EncounterOrEpisode maps to DomainResource:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.source
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource obf-EncounterOrEpisode
... extension 2..*
... obf-Status-extension 1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension 0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Identifier-extension
... obf-StatusHistory-extension 0..*(Complex)StatusHistory
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-StatusHistory-extension
... obf-datatype-TimePeriod-extension 0..1PeriodTimePeriod
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-TimePeriod-extension
... obf-EncounterDiagnosis-extension 0..*(Complex)EncounterDiagnosis
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-EncounterDiagnosis-extension
... obf-SubjectOfRecord-extension 1..1Reference(US Core Patient Profile | US Core Practitioner Profile | Group | US Core Device Profile | Specimen | US Core Location Profile | US Core Medication Profile | ResearchSubject)SubjectOfRecord
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension
.... valueReference Reference(US Core Patient Profile)Patient: A person in the role of a patient
... obf-datatype-Type-extension 0..*CodeableConceptType
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Type-extension
... obf-Organization-extension 0..1Reference(US Core Organization Profile)Organization
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Organization-extension
... obf-BasedOn-extension 0..*Reference(ServiceRequest | US Core MedicationRequest Profile | US Core CarePlan Profile)BasedOn
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-BasedOn-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource I0..*obf-EncounterOrEpisode
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 Σ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)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 2..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... obf-Status-extension 1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension 0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Identifier-extension
... obf-StatusHistory-extension 0..*(Complex)StatusHistory
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-StatusHistory-extension
... obf-datatype-TimePeriod-extension 0..1PeriodTimePeriod
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-TimePeriod-extension
... obf-EncounterDiagnosis-extension 0..*(Complex)EncounterDiagnosis
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-EncounterDiagnosis-extension
... obf-SubjectOfRecord-extension 1..1Reference(US Core Patient Profile | US Core Practitioner Profile | Group | US Core Device Profile | Specimen | US Core Location Profile | US Core Medication Profile | ResearchSubject)SubjectOfRecord
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension"
.... valueReference 1..1Reference(US Core Patient Profile)Patient: A person in the role of a patient
... obf-datatype-Type-extension 0..*CodeableConceptType
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Type-extension
... obf-Organization-extension 0..1Reference(US Core Organization Profile)Organization
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Organization-extension
... obf-BasedOn-extension 0..*Reference(ServiceRequest | US Core MedicationRequest Profile | US Core CarePlan Profile)BasedOn
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-BasedOn-extension
... modifierExtension ?!0..*(Slice Definition)Extensions that cannot be ignored
Slice: Unordered, Open by value:url

doco Documentation for this format

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.EncounterOrEpisode maps to DomainResource:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.source
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource obf-EncounterOrEpisode
... extension 2..*
... obf-Status-extension 1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension 0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Identifier-extension
... obf-StatusHistory-extension 0..*(Complex)StatusHistory
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-StatusHistory-extension
... obf-datatype-TimePeriod-extension 0..1PeriodTimePeriod
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-TimePeriod-extension
... obf-EncounterDiagnosis-extension 0..*(Complex)EncounterDiagnosis
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-EncounterDiagnosis-extension
... obf-SubjectOfRecord-extension 1..1Reference(US Core Patient Profile | US Core Practitioner Profile | Group | US Core Device Profile | Specimen | US Core Location Profile | US Core Medication Profile | ResearchSubject)SubjectOfRecord
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension
.... valueReference Reference(US Core Patient Profile)Patient: A person in the role of a patient
... obf-datatype-Type-extension 0..*CodeableConceptType
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Type-extension
... obf-Organization-extension 0..1Reference(US Core Organization Profile)Organization
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Organization-extension
... obf-BasedOn-extension 0..*Reference(ServiceRequest | US Core MedicationRequest Profile | US Core CarePlan Profile)BasedOn
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-BasedOn-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource I0..*obf-EncounterOrEpisode
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 Σ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)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 2..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... obf-Status-extension 1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension 0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Identifier-extension
... obf-StatusHistory-extension 0..*(Complex)StatusHistory
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-StatusHistory-extension
... obf-datatype-TimePeriod-extension 0..1PeriodTimePeriod
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-TimePeriod-extension
... obf-EncounterDiagnosis-extension 0..*(Complex)EncounterDiagnosis
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-EncounterDiagnosis-extension
... obf-SubjectOfRecord-extension 1..1Reference(US Core Patient Profile | US Core Practitioner Profile | Group | US Core Device Profile | Specimen | US Core Location Profile | US Core Medication Profile | ResearchSubject)SubjectOfRecord
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension"
.... valueReference 1..1Reference(US Core Patient Profile)Patient: A person in the role of a patient
... obf-datatype-Type-extension 0..*CodeableConceptType
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Type-extension
... obf-Organization-extension 0..1Reference(US Core Organization Profile)Organization
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Organization-extension
... obf-BasedOn-extension 0..*Reference(ServiceRequest | US Core MedicationRequest Profile | US Core CarePlan Profile)BasedOn
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-BasedOn-extension
... modifierExtension ?!0..*(Slice Definition)Extensions that cannot be ignored
Slice: Unordered, Open by value:url

doco Documentation for this format

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

 

Terminology Bindings

PathConformanceValueSet
DomainResource.languagepreferredCommonLanguages
Max Binding: AllLanguages

 

Constraints

IdPathDetailsRequirements
dom-2DomainResourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4DomainResourceIf 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-3DomainResourceIf 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-6DomainResourceA resource should have narrative for robust management
: text.div.exists()
dom-5DomainResourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()