This
page
is
part
of
the
FHIR
Specification
(v1.8.0:
STU
3
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
Detailed Descriptions for the elements in the DomainResource Resource.
| DomainResource | |
| Definition |
A resource that includes narrative, extensions, and contained resources. |
| Control | 1..1 |
| Invariants |
Defined
on
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))
dom-2 : If the resource is contained in another resource, it SHALL NOT contain nested Resources ( expression
:
contained.contained.empty(),
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 ( expression
:
contained.where(('#'+id
in
%resource.descendants().reference).not()).empty(),
xpath:
not(exists(for
$id
in
f:contained/*/@id
return
$id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#',
$id))])))
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(),
xpath:
not(exists(f:contained/*/f:meta/f:versionId))
and
not(exists(f:contained/*/f:meta/f:lastUpdated)))
|
| DomainResource.text | |
| Definition |
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 safety. |
| Control | 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 is added later. |
| 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.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 | 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. |
| DomainResource.extension | |
| Definition |
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 extension. |
| Control | 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, 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 extensions. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true |
| 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. |