FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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.29 DomainResource Resource

http://www.hl7.org/Special/committees/fiwg/index.cfmMaturity Level: 5Compartments: Not linked to any defined compartments

A domain resource is an resource that:

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

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

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource IResourceA resource with narrative, extensions, and contained resources
+ If the resource is contained in another resource, it SHALL NOT contain nested Resources
+ If the resource is contained in another resource, it SHALL NOT contain any narrative
+ If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
+ If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
Elements defined in Ancestors: id, meta, implicitRules, language
... text I0..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

doco Documentation for this format

UML Diagram (Legend)

DomainResource (Resource)text : Narrative [0..1]contained : Resource [0..*]extension : Extension [0..*]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/> .

[
 # 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 IResourceA resource with narrative, extensions, and contained resources
+ If the resource is contained in another resource, it SHALL NOT contain nested Resources
+ If the resource is contained in another resource, it SHALL NOT contain any narrative
+ If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
+ If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
Elements defined in Ancestors: id, meta, implicitRules, language
... text I0..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

doco Documentation for this format

UML Diagram (Legend)

DomainResource (Resource)text : Narrative [0..1]contained : Resource [0..*]extension : Extension [0..*]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/> .

[
 # 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
]
  • dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (expression : contained.text.empty())
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (expression : contained.contained.empty())
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (expression : contained.where(('#'+id in %resource.descendants().reference).not()).empty())
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (expression : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())

To search for extensions, define a search parameter 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.

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

NameTypeDescriptionPaths
_textstringSearch on the narrative of the resource