R4 Ballot #1 (Mixed Normative/Trial use) Release 4

This page is part of the FHIR Specification (v3.3.0: (v4.0.1: R4 Ballot 2). - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). 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.26.6 2.27.6 Resource DomainResource - Detailed Descriptions

http://www.hl7.org/Special/committees/fiwg/index.cfm Maturity Level : 5 N   Normative (from v4.0.0) Compartments : Not linked to any defined compartments
Normative Candidate Note:
This page is candidate normative content for R4 in has been approved as part of an ANSI standard. See the Infrastructure Package . Once normative, it will lose it's Maturity Level, and breaking changes will no longer be made. for further details.

Detailed Descriptions for the elements in the DomainResource Resource.

Invariants Affect this element dom-1 : If the resource is contained in another resource, it SHALL NOT contain any narrative ( expression : contained.text.empty(), xpath: not(parent::f:contained and f:text))
DomainResource
Definition

A resource that includes narrative, extensions, and contained resources.

Control Cardinality 1..1 0..*
Type Resource
Invariants : contained.text.empty(), xpath: not(parent::f:contained and f:text)) : contained.contained.empty(), xpath: not(parent::f:contained and f:contained)) : contained.all(('#'+id :
Defined on this element dom-1 : If the resource is contained in another resource, it SHALL NOT contain any narrative ( expression
dom-2 : Rule If the resource is contained in another resource, it SHALL NOT contain nested Resources ( expression contained.contained.empty()
dom-3 : 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 ( expression contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists()), xpath: not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) '#').exists() or descendant::f:reference[@value='#'])]))) descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 : Rule 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(), xpath: not(exists(f:contained/*/f:meta/f:versionId)) contained.meta.lastUpdated.empty()
dom-5 Rule If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 Guideline A resource should have narrative for robust management text.`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 not(exists(f:contained/*/f:meta/f:lastUpdated))) 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.

DomainResource.text
Definition

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 safety.

Control Cardinality 0..1
Type Narrative
Alternate Names narrative; html; xhtml; display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation information is added later.

DomainResource.contained
Definition

These 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 scope.

Control Cardinality 0..*
Type Resource
Alternate Names inline resources; anonymous resources; contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

DomainResource.extension
Definition

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 extension.

Control Cardinality 0..*
Type Extension
Alternate Names extensions; user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DomainResource.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, resource and that modifies the understanding of the element that contains it. 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).

Control Cardinality 0..*
Type Extension
Is Modifier true (Reason: Not known why this is labelled a modifier) Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions .
Alternate Names extensions; user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.