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

Composition

 

The official URL for this profile is:

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

A composition represents a set of Entries sharing common provenance, a document such as an extract from a patient record, a knowledge artifact, or a catalog definition.

This profile builds on Composition.

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

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Mapping Source

This structure represents the following mapping definition:

obf.Composition maps to Composition:
  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
  Identifier maps to identifier
  Status maps to status
  Type maps to type
  Category maps to category
  FocalSubject maps to subject
  CareContext maps to encounter
  StatementDateTime maps to date
  Author maps to author
  Title maps to title
  ConfidentialityCode maps to confidentiality
  Attestation.AttestationMode maps to attester.mode
  Attestation.CreationDateTime maps to attester.time
  Attestation.Attester maps to attester.party
  ManagingOrganization maps to custodian
  RelatedDocument.Relationship maps to relatesTo.code
  RelatedDocument.TargetDocument maps to relatesTo.target[x]
  EventContext.Code maps to event.code
  EventContext.TimePeriod maps to event.period
  EventContext.SupportingInformation maps to event.detail
  Section maps to section (slice on = code.coding.code; slice strategy = includes)
  Section.Title maps to section.title
  Section.Code maps to section.code
  Section.Author maps to section.author
  Section.FocalSubject maps to section.focus
  Section.Narrative maps to section.text
  Section.Type maps to section.mode
  Section.SortOrder maps to section.orderedBy // terrible FHIR name!
  Section.Resource maps to section.entry  (slice on = reference.resolve(); slice on type = profile; slice strategy = includes)
  Section.EmptyReason maps to section.emptyReason
  Section.Section maps to section.section

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*obf-Composition
... 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 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred)
... category Σ0..1CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example)
... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... encounter Σ0..1Reference(US Core Encounter Profile)Context of the Composition
... date Σ1..1dateTimeComposition editing time
... author Σ1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Device Profile | US Core Patient Profile | RelatedPerson | US Core Organization Profile)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required)
... attester I0..*BackboneElementAttests to accuracy of composition
.... 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
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required)
.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(US Core Patient Profile | US Core Practitioner Profile | RelatedPerson | US Core Organization Profile | US Core PractitionerRole Profile)Who attested the composition
... custodian Σ0..1Reference(US Core Organization Profile)Organization which maintains the composition
... relatesTo I0..*BackboneElementRelationships to other compositions/documents
.... 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
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(obf-Composition)
... event ΣI0..*BackboneElementThe clinical service(s) being documented
.... 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
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example)
.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section I0..*BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... 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
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example)
.... author 0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Device Profile | US Core Patient Profile | RelatedPerson | US Core Organization Profile)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred)
.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred)
.... section I0..*BackboneElementNested Section
..... 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
..... title 0..1stringLabel for section (e.g. for ToC)
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example)
..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text I0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required)
..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred)
..... entry I0..*Reference(Resource)A reference to data that supports this section
..... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred)
..... section I0..*Unknown reference to #Composition.section
Nested Section

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Mapping Source

This structure represents the following mapping definition:

obf.Composition maps to Composition:
  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
  Identifier maps to identifier
  Status maps to status
  Type maps to type
  Category maps to category
  FocalSubject maps to subject
  CareContext maps to encounter
  StatementDateTime maps to date
  Author maps to author
  Title maps to title
  ConfidentialityCode maps to confidentiality
  Attestation.AttestationMode maps to attester.mode
  Attestation.CreationDateTime maps to attester.time
  Attestation.Attester maps to attester.party
  ManagingOrganization maps to custodian
  RelatedDocument.Relationship maps to relatesTo.code
  RelatedDocument.TargetDocument maps to relatesTo.target[x]
  EventContext.Code maps to event.code
  EventContext.TimePeriod maps to event.period
  EventContext.SupportingInformation maps to event.detail
  Section maps to section (slice on = code.coding.code; slice strategy = includes)
  Section.Title maps to section.title
  Section.Code maps to section.code
  Section.Author maps to section.author
  Section.FocalSubject maps to section.focus
  Section.Narrative maps to section.text
  Section.Type maps to section.mode
  Section.SortOrder maps to section.orderedBy // terrible FHIR name!
  Section.Resource maps to section.entry  (slice on = reference.resolve(); slice on type = profile; slice strategy = includes)
  Section.EmptyReason maps to section.emptyReason
  Section.Section maps to section.section

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*obf-Composition
... 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 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred)
... category Σ0..1CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example)
... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... encounter Σ0..1Reference(US Core Encounter Profile)Context of the Composition
... date Σ1..1dateTimeComposition editing time
... author Σ1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Device Profile | US Core Patient Profile | RelatedPerson | US Core Organization Profile)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required)
... attester I0..*BackboneElementAttests to accuracy of composition
.... 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
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required)
.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(US Core Patient Profile | US Core Practitioner Profile | RelatedPerson | US Core Organization Profile | US Core PractitionerRole Profile)Who attested the composition
... custodian Σ0..1Reference(US Core Organization Profile)Organization which maintains the composition
... relatesTo I0..*BackboneElementRelationships to other compositions/documents
.... 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
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(obf-Composition)
... event ΣI0..*BackboneElementThe clinical service(s) being documented
.... 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
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example)
.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section I0..*BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... 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
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example)
.... author 0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Device Profile | US Core Patient Profile | RelatedPerson | US Core Organization Profile)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred)
.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred)
.... section I0..*BackboneElementNested Section
..... 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
..... title 0..1stringLabel for section (e.g. for ToC)
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example)
..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text I0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required)
..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred)
..... entry I0..*Reference(Resource)A reference to data that supports this section
..... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred)
..... section I0..*Unknown reference to #Composition.section
Nested Section

doco Documentation for this format

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

 

Terminology Bindings

PathConformanceValueSet
Composition.languagepreferredCommonLanguages
Max Binding: AllLanguages
Composition.statusrequiredCompositionStatus
Composition.typepreferredFHIRDocumentTypeCodes
Composition.categoryexampleDocumentClassValueSet
Composition.confidentialityrequiredv3.ConfidentialityClassification
Composition.attester.moderequiredCompositionAttestationMode
Composition.relatesTo.coderequiredDocumentRelationshipType
Composition.event.codeexamplev3.ActCode
Composition.section.codeexampleDocumentSectionCodes
Composition.section.moderequiredListMode
Composition.section.orderedBypreferredListOrderCodes
Composition.section.emptyReasonpreferredListEmptyReasons
Composition.section.section.codeexampleDocumentSectionCodes
Composition.section.section.moderequiredListMode
Composition.section.section.orderedBypreferredListOrderCodes
Composition.section.section.emptyReasonpreferredListEmptyReasons

 

Constraints

IdPathDetailsRequirements
dom-2CompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4CompositionIf 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-3CompositionIf 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-6CompositionA resource should have narrative for robust management
: text.div.exists()
dom-5CompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1Composition.attesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.relatesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.eventAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.sectionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
cmp-1Composition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()