2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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

1.13.2 DomainResource Resource

1.13.2.1 Scope and Usage

This resource is defined to add text, contained resources, and extension support to the base resource. As an abstract resource, this resource never exists directly, only one of it's descendent resources (list).

For further information:

1.13.2.2 Boundaries and Relationships

This resource is extends resource. All of the listed resources except Bundle and Binary extend this resource.

1.13.2.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource IResourceA resource with narrative, extensions, and contained resources
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
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
... 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

UML Diagram

DomainResource (Resource)A human-readable narrative that contains a summary of the resource, and may 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..1These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and 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. In order 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 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. Usually modifier elements provide negation or qualification. In order 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 extensionsmodifierExtension : 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]>

JSON Template

{doco
  "resourceType" : "[name]",
  // from Resource: id, meta, implicitRules, and language
  "text" : { Narrative }, // C? Text summary of the resource, for human interpretation
  "contained" : [{ Resource }], // Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource IResourceA resource with narrative, extensions, and contained resources
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
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
... 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

UML Diagram

DomainResource (Resource)A human-readable narrative that contains a summary of the resource, and may 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..1These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and 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. In order 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 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. Usually modifier elements provide negation or qualification. In order 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 extensionsmodifierExtension : 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]>

JSON Template

{doco
  "resourceType" : "[name]",
  // from Resource: id, meta, implicitRules, and language
  "text" : { Narrative }, // C? Text summary of the resource, for human interpretation
  "contained" : [{ Resource }], // Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
}

1.13.2.3.1 Constraints

  • dom-1: If the resource is contained in another resource, it SHALL not contain any narrative (xpath: not(parent::f:contained and f:text))
  • dom-2: If the resource is contained in another resource, it SHALL not contain nested Resources (xpath: not(parent::f:contained and f:contained))
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (xpath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])))

1.13.2.4 Search Parameters

This resource doesn't define any common Search parameters

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 it's URL, and then searches can filter based on the value of the extension.