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

This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

EntityProfile

 

The official URL for this profile is: 

http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Entity

Root class for entities such as people, organizations, and devices that have a separately identifiable existence.

This profile builds on Basic.

This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by HL7.

View the corresponding EntityModel logical model.

Summary

ODH Mapping Source

This structure represents the following ODH mapping definition:

cimi.entity.Entity maps to Basic:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic ODH Entity Profile
... code Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/odh/CodeSystem/ODH-basic-resource-type","code":"cimi-entity-Entity"}]}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*ODH Entity Profile
... 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: Common Languages (extensible)
... text I0..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..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/odh/CodeSystem/ODH-basic-resource-type","code":"cimi-entity-Entity"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner | Patient | RelatedPerson)Who created

doco Documentation for this format

Summary

ODH Mapping Source

This structure represents the following ODH mapping definition:

cimi.entity.Entity maps to Basic:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic ODH Entity Profile
... code Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/odh/CodeSystem/ODH-basic-resource-type","code":"cimi-entity-Entity"}]}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*ODH Entity Profile
... 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: Common Languages (extensible)
... text I0..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..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/odh/CodeSystem/ODH-basic-resource-type","code":"cimi-entity-Entity"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner | Patient | RelatedPerson)Who created

doco Documentation for this format

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

 

Terminology Bindings

PathNameConformanceValueSet
Basic.languageCommon LanguagesextensibleCommon Languages
Basic.codeBasic Resource TypesexampleBasic Resource Types

 

Constraints

IdPathDetailsRequirements
dom-2BasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1BasicIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4BasicIf 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-3BasicIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()