Generated Narrative: StructureDefinition profile-StructureDefinition-for-DataElement Name Flags Card. Type Description & Constraints DataElement 0..* DataElement Resource data element #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:type 1..1 code R4: fhirpath | element | extension (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-StructureDefinition.context.type Binding: R4ExtensionContextTypeForR3 (0.1.0) (required): How an extension context is interpreted. #xD; Documentation for this format
Cross-version Profile for R4.StructureDefinition for use in FHIR STU3
This cross-version profile allows R4 StructureDefinition content to be represented via FHIR STU3 DataElement resources.
The formal description of a single piece of information that can be gathered and reported.
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))]))
Observation[classCode=OBS, moodCode=DEFN]
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.
R4: fhirpath | element | extension (new)
R4: `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).
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')])
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 data element (globally unique)
An absolute URI that is used to identify this data element 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 data element is (or will be) published. The URL SHOULD include the major version of the data element. 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 data element to be referenced by a single globally unique identifier.
(Identified_Item).identifier As assigned by registering authority
Additional identifier for the data element
A formal identifier that is used to identify this data element 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 data element 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.
The identifier that is used to identify this version of the data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element 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 data element 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 data element with the format [url]|[version].
The status of this data element. Enables tracking the life-cycle of the content.
Allows filtering of data elements that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use a retired data element without due consideration.
The lifecycle status of a Value Set or Concept Map.
./status (draft = new active = active retired = aborted)
(Administered_item).registration.state new = Incomplete, Candidate, Recorded, Qualified active = Standard, Preferred Standard, Application retired = Retired, Superseded, Historical
A boolean value to indicate that this data element is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Allows filtering of data element that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental data element in production.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level data element.
The date (and optionally time) when the data element 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 data element changes.
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the data element. 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 data element.
Usually an organization, but may be an individual. The publisher (or steward) of the data element is the organization or individual primarily responsible for the maintenance and upkeep of the data element. 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 data element. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the data element. May also allow for contact.
Name for this data element (computer friendly)
A natural language name identifying the data element. 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 data element (human friendly)
A short, descriptive, user-friendly title for the data element.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. This may be similar to the question used to prompt someone for a data element value, but the purpose is communicating about the data element, not asking the question. (Refer to the 'question' element for the latter.).
(Designatable_Item).designation.sign acceptability=preferred in default context
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.
(Administered_Item).stewardship_record.organization.[email_address, phone_number, uri]
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 data element instances.
When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Assist in searching for appropriate content.
./inboundRelationship[typeCode=SUBJ]/source[classCode=LIST, moodCode=EVN]/code
Intended jurisdiction for data element (if applicable)
A legal or geographic region in which the data element is intended to be used.
It may be possible for the data element 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
A copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element.
null The copyright statement does not apply to values for the data element, only to its definition.
Consumers must be able to determine any legal restrictions on the use of the data element and/or its content.
comparable | fully-specified | equivalent | convertable | scaleable | flexible
Identifies how precise the data element is in its definition.
Allows determining the degree of comparability of data element instances. Less granular data elements result in data that is less comparable (or at least requires more work to compare).
Indicates the degree of precision of the data element definition.
./target[typeCode=SUBJ]/source[classCode=OBS, moodCode=EVN, code="granularity"]/value
Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.
At least one of name or uri SHALL be present
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
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 on a per-element basis.
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.
Defines the structure, type, allowed values and other constraining characteristics of the data element.
For simple data types there will only be one repetition. For complex data types, multiple repetitions will be present defining a nested structure using the "path" element.