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

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

DomainResource

The official URL for this profile is:

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

Parent class for any item in clinical or administrative health-related system. A DomainResource can belong to a single person's health record, or represent an entity that surfaces in multiple records, such as organizations, providers, payments, decision support artifacts, etc.

Note to FHIR implementers: Objective FHIR includes Status and Identifier fields on DomainResource because these two attributes occur in almost every FHIR resource. The most significant exception are 3 or 4 resources that use an 'active' flag instead of coded status value. There is no apparent pattern to this inconsistency. FHIR resources that use a coded status have active and inactive as status values. In the spirit of providing a consistent object-oriented logical model for FHIR, Objective FHIR uses status across all domain resources.

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.

Text Summary
Differential Table
Snapshot Table
All

Summary

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

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

Name	Card.	Type	Description & Constraints
DomainResource			obf-DomainResource
obf-Status-extension	0..1	CodeableConcept	Status URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Status-extension
obf-datatype-Identifier-extension	0..*	Identifier	Identifier URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-Identifier-extension
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DomainResource	I	0..*		obf-DomainResource 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..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
obf-Status-extension		0..1	CodeableConcept	Status URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Status-extension
obf-datatype-Identifier-extension		0..*	Identifier	Identifier URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-Identifier-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Documentation for this format

Summary

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

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

Name	Card.	Type	Description & Constraints
DomainResource			obf-DomainResource
obf-Status-extension	0..1	CodeableConcept	Status URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Status-extension
obf-datatype-Identifier-extension	0..*	Identifier	Identifier URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-Identifier-extension
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DomainResource	I	0..*		obf-DomainResource 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..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
obf-Status-extension		0..1	CodeableConcept	Status URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Status-extension
obf-datatype-Identifier-extension		0..*	Identifier	Identifier URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-Identifier-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Documentation for this format

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

Terminology Bindings

Path	Conformance	ValueSet
DomainResource.language	preferred	CommonLanguages Max Binding: AllLanguages

Constraints

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