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

PersonProfile

 

The official URL for this profile is: 

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

A person relevant to the health or social situation of the subject (including the person of record him or herself).

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 PersonModel logical model.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic ODH Person Profile
... extension 2..*
... shr-core-HumanName-extension 1..*HumanNameODH HumanName Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-HumanName-extension
... cimi-entity-DateOfBirth-extension 0..1date, PeriodODH DateOfBirth Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-DateOfBirth-extension
... cimi-entity-AdministrativeGender-extension 1..1codeODH AdministrativeGender Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-AdministrativeGender-extension
Binding: AdministrativeGender (required)
... shr-core-Address-extension 0..*AddressODH Address Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-extension
... cimi-entity-Headshot-extension 0..*AttachmentODH Headshot Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Headshot-extension
... shr-core-ContactPoint-extension 0..*ContactPointODH ContactPoint Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-ContactPoint-extension
... cimi-entity-LanguageUsed-extension 0..*(Complex)ODH LanguageUsed Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-LanguageUsed-extension
... cimi-entity-ActiveFlag-extension 0..1booleanODH ActiveFlag Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-ActiveFlag-extension
... cimi-entity-MaritalStatus-extension 0..1CodeableConceptODH MaritalStatus Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-MaritalStatus-extension
Binding: Marital Status Codes (extensible)
... code Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/odh/CodeSystem/ODH-basic-resource-type","code":"cimi-entity-Person"}]}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*ODH Person 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 2..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-HumanName-extension 1..*HumanNameODH HumanName Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-HumanName-extension
... cimi-entity-DateOfBirth-extension 0..1date, PeriodODH DateOfBirth Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-DateOfBirth-extension
... cimi-entity-AdministrativeGender-extension 1..1codeODH AdministrativeGender Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-AdministrativeGender-extension
Binding: AdministrativeGender (required)
... shr-core-Address-extension 0..*AddressODH Address Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-extension
... cimi-entity-Headshot-extension 0..*AttachmentODH Headshot Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Headshot-extension
... shr-core-ContactPoint-extension 0..*ContactPointODH ContactPoint Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-ContactPoint-extension
... cimi-entity-LanguageUsed-extension 0..*(Complex)ODH LanguageUsed Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-LanguageUsed-extension
... cimi-entity-ActiveFlag-extension 0..1booleanODH ActiveFlag Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-ActiveFlag-extension
... cimi-entity-MaritalStatus-extension 0..1CodeableConceptODH MaritalStatus Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-MaritalStatus-extension
Binding: Marital Status Codes (extensible)
... 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-Person"}]}
... 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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic ODH Person Profile
... extension 2..*
... shr-core-HumanName-extension 1..*HumanNameODH HumanName Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-HumanName-extension
... cimi-entity-DateOfBirth-extension 0..1date, PeriodODH DateOfBirth Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-DateOfBirth-extension
... cimi-entity-AdministrativeGender-extension 1..1codeODH AdministrativeGender Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-AdministrativeGender-extension
Binding: AdministrativeGender (required)
... shr-core-Address-extension 0..*AddressODH Address Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-extension
... cimi-entity-Headshot-extension 0..*AttachmentODH Headshot Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Headshot-extension
... shr-core-ContactPoint-extension 0..*ContactPointODH ContactPoint Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-ContactPoint-extension
... cimi-entity-LanguageUsed-extension 0..*(Complex)ODH LanguageUsed Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-LanguageUsed-extension
... cimi-entity-ActiveFlag-extension 0..1booleanODH ActiveFlag Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-ActiveFlag-extension
... cimi-entity-MaritalStatus-extension 0..1CodeableConceptODH MaritalStatus Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-MaritalStatus-extension
Binding: Marital Status Codes (extensible)
... code Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/odh/CodeSystem/ODH-basic-resource-type","code":"cimi-entity-Person"}]}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*ODH Person 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 2..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-HumanName-extension 1..*HumanNameODH HumanName Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-HumanName-extension
... cimi-entity-DateOfBirth-extension 0..1date, PeriodODH DateOfBirth Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-DateOfBirth-extension
... cimi-entity-AdministrativeGender-extension 1..1codeODH AdministrativeGender Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-AdministrativeGender-extension
Binding: AdministrativeGender (required)
... shr-core-Address-extension 0..*AddressODH Address Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-extension
... cimi-entity-Headshot-extension 0..*AttachmentODH Headshot Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Headshot-extension
... shr-core-ContactPoint-extension 0..*ContactPointODH ContactPoint Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-ContactPoint-extension
... cimi-entity-LanguageUsed-extension 0..*(Complex)ODH LanguageUsed Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-LanguageUsed-extension
... cimi-entity-ActiveFlag-extension 0..1booleanODH ActiveFlag Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-ActiveFlag-extension
... cimi-entity-MaritalStatus-extension 0..1CodeableConceptODH MaritalStatus Extension
URL: http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-MaritalStatus-extension
Binding: Marital Status Codes (extensible)
... 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-Person"}]}
... 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()