This page is part of the FHIR Specification (v5.0.0-ballot: R5 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
FHIR Infrastructure Work Group | Maturity Level: N | Normative (from v4.0.0) | Security Category: N/A | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the DomainResource Resource.
DomainResource | |||||||||||||||||||||||||
Definition | A resource that includes narrative, extensions, and contained resources. | ||||||||||||||||||||||||
Short Display | A resource with narrative, extensions, and contained resources | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Short Display | Text summary of the resource, for human interpretation | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Narrative | ||||||||||||||||||||||||
Alternate Names | narrative; html; xhtml; display | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | Contained resources do not have a 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 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | ||||||||||||||||||||||||
Short Display | Contained, inline Resources | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||
Alternate Names | inline resources; anonymous resources; contained resources | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions; user content | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
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 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). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: 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 | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
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. |