Generated Narrative: StructureDefinition profile-StructureDefinition Name Flags Card. Type Description & Constraints StructureDefinition 0..* StructureDefinition Structural Definition #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm #xD; extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel #xD; contact #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:contact 0..* (Complex) R5: Contact details for the publisher additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-StructureDefinition.contact #xD; fhirVersion #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:fhirVersion 0..1 code R5: fhirVersion additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-StructureDefinition.fhirVersion Binding: R5FHIRVersionForR3 (0.1.0) (required): All published FHIR Versions. #xD; context #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:type 1..1 code R5: fhirpath | element | extension (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-StructureDefinition.context.type Binding: R5ExtensionContextTypeForR3 (0.1.0) (required): How an extension context is interpreted. #xD; Documentation for this format
Cross-version Profile for R5.StructureDefinition for use in FHIR STU3
This cross-version profile allows R5 StructureDefinition content to be represented via FHIR STU3 StructureDefinition resources.
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.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL NOT contain any narrative
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition
In any snapshot or differential, no label, code or requirements on the an element without a "." in the path (e.g. the first element)
children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()
not(exists(f:snapshot/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)])) and not(exists(f:differential/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)]))
Custom types can only be used in logical models
kind = 'logical' or (differential.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')) and snapshot.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')))
f:kind/@value = 'logical' or count(f:differential/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]|f:snapshot/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]) =0
All element definitions must have unique ids (snapshot)
Context Invariants can only be used for extensions
contextInvariant.exists() implies type = 'Extension'
not(exists(f:contextInvariant)) or (f:type/@value = 'Extension')
All element definitions must have unique ids (diff)
Ensure that the type is not inconsistent with the other information in the structure
If there's a type, its content must match the path name in the first element of a snapshot
snapshot.empty() or snapshot.element.first().path = type
not(exists(f:snapshot)) or (f:type/@value = f:snapshot/f:element[1]/f:path/@value)
snapshot.element.all(id.exists()) and differential.element.all(id.exists())
Element paths must be unique unless the structure is a constraint
derivation = 'constraint' or snapshot.element.select(path).isDistinct()
(f:derivation/@value = 'constraint') or (count(f:snapshot/f:element) = count(distinct-values(f:snapshot/f:element/f:path/@value)))
If the structure describes a base Resource or Type, the URL has to start with "http://hl7.org/fhir/StructureDefinition/" and the tail must match the id
(derivation = 'constraint') or (kind = 'logical') or (url = 'http://hl7.org/fhir/StructureDefinition/'+id)
(f:derivation/@value = 'constraint') or (f:kind/@value = 'logical') or (f:url/@value=concat('http://hl7.org/fhir/StructureDefinition/', f:id/@value))
A structure must have either a differential, or a snapshot (or both)
snapshot.exists() or differential.exists()
exists(f:snapshot) or exists(f:differential)
If the structure defines an extension then the structure must have context information
type != 'Extension' or derivation = 'specialization' or (context.exists() and contextType.exists())
not(f:type/@value = 'extension') or (f:derivation/@value = 'specialization') or (exists(f:context) and exists(f:contextType))
If the structure is not abstract, then there SHALL be a baseDefinition
abstract = true or baseDefinition.exists()
(f:abstract/@value=true()) or exists(f:baseDefinition)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
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.
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.
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.
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.
R5: `StructureDefinition.versionAlgorithm[x]` (new:Coding, string)
Element `StructureDefinition.versionAlgorithm[x]` has a context of DataElement based on following the parent source element upwards and mapping to `DataElement`. Element `StructureDefinition.versionAlgorithm[x]` has a context of StructureDefinition based on following the parent source element upwards and mapping to `StructureDefinition`. Element `StructureDefinition.versionAlgorithm[x]` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `StructureDefinition.versionAlgorithm[x]`: `http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm`. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
R5: `StructureDefinition.copyrightLabel` (new:string)
Element `StructureDefinition.copyrightLabel` has a context of DataElement based on following the parent source element upwards and mapping to `DataElement`. Element `StructureDefinition.copyrightLabel` has a context of StructureDefinition based on following the parent source element upwards and mapping to `StructureDefinition`. Element `StructureDefinition.copyrightLabel` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `StructureDefinition.copyrightLabel`: `http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel`. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
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.
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.
Logical URI to reference this structure definition (globally unique)
An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](http://hl7.org/fhir/STU3/resource.html#versions).
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.
Allows the structure definition to be referenced by a single globally unique identifier.
Additional identifier for the structure 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.
Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this structure definition outside of FHIR, where it is not possible to use the logical URI.
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Business version of the structure 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.
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 refrence to a particular business version of the structure definition with the format [url]|[version].
Name for this structure definition (computer friendly)
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.
The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.
Support human navigation and code generation.
Name for this structure definition (human friendly)
A short, descriptive, user-friendly title for the structure definition.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Applications don't have to use this name, but can always fall back to it. The title also corresponds to the label for the root element.
The status of this structure definition. Enables tracking the life-cycle of the content.
Allows filtering of structure definitions that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use a retired structure definition without due consideration.
The lifecycle status of a Value Set or Concept Map.
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.
Allows filtering of structure definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental structure definition in production.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition.
The date (and optionally time) when the structure definition was published. The date must change if and 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.
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.
Name of the publisher (organization or individual)
The name of the individual or organization that published the structure definition.
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.
Helps establish the "authority/credibility" of the structure definition. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
R5: Contact details for the publisher additional types
R5: `StructureDefinition.contact` additional types (ContactDetail) additional types from child elements (name, telecom)
Element `StructureDefinition.contact` is mapped to FHIR STU3 element `DataElement.contact` as `SourceIsBroaderThanTarget`. Element `StructureDefinition.contact` is mapped to FHIR STU3 element `StructureDefinition.contact` as `SourceIsBroaderThanTarget`. The mappings for `StructureDefinition.contact` do not cover the following types: ContactDetail. The mappings for `StructureDefinition.contact` do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).
If there is no named individual, the telecom information is for the organization as a whole.
Contact details for individual or organization
The contact details for the individual (if a name was provided) or the organization.
Natural language description of the structure definition
A free text natural language description of the structure definition from a consumer's perspective.
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 profile is presumed to be the predominant language in the place the profile was created).
Context the content is intended to support
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.
When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for structure definition (if applicable)
A legal or geographic region in which the structure definition is intended to be used.
It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use
Why this structure definition is defined
Explaination of why this structure definition is needed and why it has been designed as it has.
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.
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.
Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content.
A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.
Assist in searching for appropriate StructureDefinitions.
Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).
FHIR Version this StructureDefinition targets
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 3.0.2 for this version.
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.
unique id for the element within a resource (for internal references)
R5: `StructureDefinition.fhirVersion` additional types (code) additional types from child elements (value)
Element `StructureDefinition.fhirVersion` is mapped to FHIR STU3 element `StructureDefinition.fhirVersion` as `SourceIsBroaderThanTarget`. The mappings for `StructureDefinition.fhirVersion` do not cover the following types: code. The mappings for `StructureDefinition.fhirVersion` do not cover the following types based on type expansion: value. 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.
All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
External specification that the content is mapped to
An external specification that the content is mapped to.
Must have at least a name or a uri (or both)
Additional Content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. 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.
May be used to represent additional information that is not part of the basic definition of the element, 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.
An Internal id that is used to identify this mapping set when specific mappings are made.
The specification is described once, with general comments, and then specific mappings are made that reference this declaration.
An absolute URI that identifies the specification that this mapping is expressed to.
A formal identity for the specification being mapped to helps with identifying maps consistently.
A name for the specification that is being mapped to.
Versions, Issues, Scope limitations etc.
Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.
primitive-type | complex-type | resource | logical
Defines the kind of structure that this definition is describing.
Defines the type of structure that a definition is describing.
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.
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 profile, but have children described, are anonymous concrete types that specialise Element.
If this is an extension, Identifies the context within FHIR resources where the extension can be used.
How an extension context is interpreted.
Where the extension can be used in instances
Identifies the types of resource or data type elements to which the extension can be applied.
If the context is an element that can have multiple types, then use (e.g.) value[x] if the extension works on all choice types, or otherwise an enumeration of explicitly named elements if not. Note that a context of "string" doesn't mean that the extension can be used with one of the string patterns such as "id" etc.
R5: fhirpath | element | extension (new)
R5: `StructureDefinition.context.type` (new:code)
Element `StructureDefinition.context.type` has a context of DataElement based on following the parent source element upwards and mapping to `DataElement`. Element `StructureDefinition.context.type` has a context of StructureDefinition.context based on following the parent source element upwards and mapping to `StructureDefinition`. Element `StructureDefinition.context.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
FHIRPath invariants - when the extension can be used
A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
All the rules must be true. When evaluating the invariant, the fluentpath focus is the element that holds the extension, and %extension refers to the extension itself.
Type defined or constrained by this structure
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).
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.
Either a resource or a data type, including logical model types
Definition that this type is constrained/specialized from
An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
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.
specialization | constraint - How relates to base definition
How the type relates to the baseDefinition.
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 can not define new elements, it can only make new rules about existing content (see [Profiling Resources](http://hl7.org/fhir/STU3/profiling.html#resources)).
How a type relates to its baseDefinition.
A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
The first element in a snapshot has no type
kind!='logical' implies snapshot.element.first().type.empty()
In any snapshot, all the elements must be in the specified type
(%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))
f:element[1]/f:path/@value=parent::f:StructureDefinition/f:type/@value and count(f:element[position()!=1])=count(f:element[position()!=1][starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])
Each element definition in a snapshot must have a formal definition and cardinalities
count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)])
Definition of elements in the resource (if no StructureDefinition)
Captures constraints on each element within the resource.
A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
No Type on the root element (differential)
If the first element in a differential has no "." in the path, it has no type
element.first().path.contains('.').not() implies element.first().type.empty()
not(f:element[1][not(contains(f:path/@value, '.'))]/f:type)
In any differential, all the elements must be in the specified type
element.first().path.startsWith(%resource.type) and element.tail().all(path.startsWith(%resource.type&'.'))
count(f:element)=count(f:element[f:path/@value=ancestor::f:StructureDefinition/f:type/@value or starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])