Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

2.28 DomainResource Resource

http://www.hl7.org/Special/committees/fiwg/index.cfmMaturity Level: N Normative (from v4.0.0) Compartments: Not linked to any defined compartments
This page has been approved as part of an ANSI standard. See the Infrastructure Package for further details.

2.28.1 Scope and Usage

A domain resource is a resource that:

As an abstract resource, this resource is never created directly; instead, one of its descendant resources (see List of Resources) is created.

2.28.2 Boundaries and Relationships

This resource extends the base Resource. All of the listed Resources except Bundle, Parameters and Binary extend this resource.

2.28.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource «I»NResourceA resource with narrative, extensions, and contained resources
+ Rule: If the resource is contained in another resource, it SHALL NOT contain nested Resources
+ Rule: 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
+ Rule: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
+ Rule: If a resource is contained in another resource, it SHALL NOT have a security label
+ Guideline: A resource should have narrative for robust management
Elements defined in Ancestors: id, meta, implicitRules, language
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations

doco Documentation for this format

UML Diagram (Legend)

DomainResource (Resource)A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safetytext : Narrative [0..1]These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scopecontained : Resource [0..*]May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extensionextension : Extension [0..*]May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)modifierExtension : Extension [0..*]

XML Template

<[name] xmlns="http://hl7.org/fhir"> doco
 <!-- from Element: extension -->
 <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <extension><!-- 0..* Extension Additional content defined by implementations --></extension>
 <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension>
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:[name];
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

 # from Element: Element.extension
  fhir:DomainResource.text [ Narrative ]; # 0..1 Text summary of the resource, for human interpretation
  fhir:DomainResource.contained [ Resource ], ... ; # 0..* Contained, inline Resources
  fhir:DomainResource.extension [ Extension ], ... ; # 0..* Additional content defined by implementations
  fhir:DomainResource.modifierExtension [ Extension ], ... ; # 0..* Extensions that cannot be ignored
]

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource «I»NResourceA resource with narrative, extensions, and contained resources
+ Rule: If the resource is contained in another resource, it SHALL NOT contain nested Resources
+ Rule: 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
+ Rule: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
+ Rule: If a resource is contained in another resource, it SHALL NOT have a security label
+ Guideline: A resource should have narrative for robust management
Elements defined in Ancestors: id, meta, implicitRules, language
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations

doco Documentation for this format

UML Diagram (Legend)

DomainResource (Resource)A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safetytext : Narrative [0..1]These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scopecontained : Resource [0..*]May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extensionextension : Extension [0..*]May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)modifierExtension : Extension [0..*]

XML Template

<[name] xmlns="http://hl7.org/fhir"> doco
 <!-- from Element: extension -->
 <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <extension><!-- 0..* Extension Additional content defined by implementations --></extension>
 <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension>
</[name]>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:[name];
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

 # from Element: Element.extension
  fhir:DomainResource.text [ Narrative ]; # 0..1 Text summary of the resource, for human interpretation
  fhir:DomainResource.contained [ Resource ], ... ; # 0..* Contained, inline Resources
  fhir:DomainResource.extension [ Extension ], ... ; # 0..* Additional content defined by implementations
  fhir:DomainResource.modifierExtension [ Extension ], ... ; # 0..* Extensions that cannot be ignored
]

2.28.3.1 Constraints

idLevelLocationDescriptionExpression
dom-2Rule (base)If the resource is contained in another resource, it SHALL NOT contain nested Resourcescontained.contained.empty()
dom-3Rule (base)If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resourcecontained.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-4Rule (base)If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdatedcontained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5Rule (base)If a resource is contained in another resource, it SHALL NOT have a security labelcontained.meta.security.empty()
dom-6Guideline (base)A resource should have narrative for robust managementtext.`div`.exists()
This is (only) a best practice guideline because:

When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

2.28.4 Searching Extensions

To search for extensions, define a SearchParameter for the extension. All other search parameters are named aliases for existing content in the resource. In some cases, though not all, the search parameter name is the same as the element that it searches, but this is not required. Searching for extensions is the same - define a name that identifies the value extension by its URL, and then searches can filter based on the value of the extension.

2.28.5 Search Parameters

Common search parameters defined by this resource. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
_textspecialSearch on the narrative of the resource