This
page
is
part
of
the
FHIR
Specification
(v3.3.0:
(v3.5.0:
R4
Ballot
2).
#2).
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 : 5 | Normative | Compartments : Not linked to any defined compartments |
Detailed Descriptions for the elements in the StructureDefinition resource.
| StructureDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | DomainResource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Alternate Names | Template; Profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.url | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.url | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requirements |
Allows the structure definition to be referenced by a single globally unique identifier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Alternate Names | url; authoritative-url; destination; identity | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Note | This is a business identifer, not a resource identifier (see discussion ) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | Identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requirements |
Allows externally provided and/or usable business identifiers to be easily associated with the module. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.version | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.version | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Note | This is a business versionId, not a resource version id (see discussion ) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version]. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requirements |
Support human navigation and code generation. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
The
name
is
not
expected
to
be
globally
unique.
The
name
should
be
a
simple
alphanumeric
type
name
to
ensure
that
it
is
machine-processing
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.title | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.title | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A short, descriptive, user-friendly title for the structure definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
This
name
does
not
need
to
be
machine-processing
friendly
and
may
contain
punctuation,
white-space,
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
The status of this structure definition. Enables tracking the life-cycle of the content. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | PublicationStatus ( Required ) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Is Modifier |
true
(Reason:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
Allows filtering of structure definitions that are appropriate for use versus not. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.experimental | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.experimental | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
Allows filtering of structure definitions that are appropriate for use versus not. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.date | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
The date (and optionally time) when the structure definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Alternate Names | Revision Date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.publisher | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.publisher | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
The name of the organization or individual that published the structure definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requirements |
Helps establish the "authority/credibility" of the structure definition. May also allow for contact. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.contact | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.contact | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
Contact details to assist a user in finding and communicating with the publisher. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | ContactDetail | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
May be a web site, an email address, a telephone number, etc. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A free text natural language description of the structure definition from a consumer's perspective. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
This
description
can
be
used
to
capture
details
such
as
why
the
structure
definition
was
built,
comments
about
misuse,
instructions
for
clinical
use
and
interpretation,
literature
references,
examples
from
the
paper
world,
etc.
It
is
not
a
rendering
of
the
structure
definition
as
conveyed
in
the
'text'
field
of
the
resource
itself.
This
item
SHOULD
be
populated
unless
the
information
is
available
from
context
(e.g.
the
language
of
the
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.useContext | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.useContext | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure definition instances. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | UsageContext | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requirements |
Assist in searching for appropriate content. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.jurisdiction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.jurisdiction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A legal or geographic region in which the structure definition is intended to be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Terminology Binding |
Jurisdiction
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.purpose | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.purpose | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
Explanation of why this structure definition is needed and why it has been designed as it has. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.copyright | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.copyright | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requirements |
Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Alternate Names | License; Restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.keyword | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.keyword | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A
set
of
key
words
or
terms
from
external
terminologies
that
may
be
used
to
assist
with
indexing
and
searching
of
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Terminology Binding |
Structure
Definition
Use
Codes
/
Keywords
(
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | Coding | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requirements |
Assist in searching for appropriate StructureDefinitions. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.fhirVersion | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.fhirVersion | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
The
version
of
the
FHIR
specification
on
which
this
StructureDefinition
is
based
-
this
is
the
formal
version
of
the
specification,
without
the
revision
number,
e.g.
[publication].[major].[minor],
which
is
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Terminology Binding |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.mapping | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.mapping | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
An external specification that the content is mapped to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.mapping.identity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.mapping.identity | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
An Internal id that is used to identify this mapping set when specific mappings are made. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
The specification is described once, with general comments, and then specific mappings are made that reference this declaration. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.mapping.uri | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.mapping.uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
An absolute URI that identifies the specification that this mapping is expressed to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
A formal identity for the specification being mapped to helps with identifying maps consistently. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.mapping.name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.mapping.name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A name for the specification that is being mapped to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.mapping.comment | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.mapping.comment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.kind | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.kind | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
Defines the kind of structure that this definition is describing. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | StructureDefinitionKind ( Required ) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.abstract | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.abstract | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
Abstract
Resources
cannot
be
instantiated
-
a
concrete
sub-type
must
be
used.
Abstract
datatypes
and
extensions
cannot
be
used
in
an
instance.
For
logical
models,
the
exact
implication
of
"abstract"
will
rest
with
the
author,
depending
how
the
logical
model
is
used.
Flagging
a
constraint
structure
as
abstract
conveys
design
intent
but
makes
no
difference
to
how
the
structure
definition
is
handled.
Note
that
inline
declared
elements
that
are
given
the
type
"Element"
in
the
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.context | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.context | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
Identifies the types of resource or data type elements to which the extension can be applied. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.context.type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.context.type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
Defines how to interpret the expression that defines what the context of the extension is. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | ExtensionContextType ( Required ) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.context.expression | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.context.expression | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
An expression that defines where an extension can be used in resources. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.contextInvariant | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.contextInvariant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | FHIRDefinedType ( Extensible ) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a concrete structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. The type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type is a URL, the type name SHOULD start with the tail of the type URL where required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.baseDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.baseDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
An absolute URI that is the base structure from which this type is derived, either by specialization or constraint. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | canonical ( StructureDefinition ) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Hierarchy | This reference is part of a strict Hierarchy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
If differential constraints are specified in this structure, they are applied to the base in a "differential" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of "Element" or another logical model. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.derivation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.derivation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
How the type relates to the baseDefinition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Terminology Binding | TypeDerivationRule ( Required ) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Comments |
If the definition is a specialization, then it adds new elements in the differential, and the snapshot includes the inherited elements. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see Profiling Resources ). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.snapshot | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.snapshot | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.snapshot.element | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.snapshot.element | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
Captures constraints on each element within the resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | ElementDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.differential | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.differential | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StructureDefinition.differential.element | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Element Id | StructureDefinition.differential.element | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Definition |
Captures constraints on each element within the resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Control | 1..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | ElementDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||