HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU Ballot 1

This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v0.9.1: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Entity

 

The official URL for this profile is: 

http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Entity

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

This profile builds on DomainResource.

This profile was published on Thu Aug 01 00:00:00 EDT 2019 as a active by HL7 International Clinical Interoperability Council.

Summary

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.Entity 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 I0..*obf-Entity
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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... obf-Status-extension 0..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension 0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-Identifier-extension
... obf-PartOf-extension 0..1Reference(Resource)PartOf
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-PartOf-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url

doco Documentation for this format

Summary

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.Entity 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource I0..*obf-Entity
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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... obf-Status-extension 0..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension 0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-Identifier-extension
... obf-PartOf-extension 0..1Reference(Resource)PartOf
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-PartOf-extension
... modifierExtension ?!0..*ExtensionExtensions 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()