This is the set of resources that conform to either of the profiles CQL StructureDefinition (http://hl7.org/fhir/uv/cql/StructureDefinition/cql-structuredefinition) and CQL StructureDefinition (http://hl7.org/fhir/uv/cql/StructureDefinition/cql-structuredefinition). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
StructureDefinition | C | 1..1 | Structural Definition dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management sdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdf-1: Element paths must be unique unless the structure is a constraint sdf-15a: If the first element in a differential has no "." in the path and it's not a logical model, it has no type sdf-4: If the structure is not abstract, then there SHALL be a baseDefinition sdf-5: If the structure defines an extension then the structure must have context information sdf-6: A structure must have either a differential, or a snapshot (or both) sdf-9: In any snapshot or differential, no label, code or requirements on an element without a "." in the path (e.g. the first element) sdf-11: If there's a type, its content must match the path name in the first element of a snapshot sdf-14: All element definitions must have an id sdf-15: The first element in a snapshot has no type unless model is a logical model. sdf-16: All element definitions must have unique ids (snapshot) sdf-17: All element definitions must have unique ids (diff) sdf-18: Context Invariants can only be used for extensions sdf-19: FHIR Specification models only use FHIR defined types sdf-21: Default values can only be specified on specializations sdf-22: FHIR Specification models never have default values sdf-23: No slice name on root | |
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | Σ | 1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
identifier | Σ | 0..* | Identifier | Additional identifier for the structure definition ele-1: All FHIR elements must have a @value or children |
version | Σ | 0..1 | string | Business version of the structure definition ele-1: All FHIR elements must have a @value or children |
name | Σ | 1..1 | string | Name for this structure definition (computer friendly) ele-1: All FHIR elements must have a @value or children |
title | Σ | 0..1 | string | Name for this structure definition (human friendly) ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
date | Σ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
description | 0..1 | markdown | Natural language description of the structure definition ele-1: All FHIR elements must have a @value or children | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support ele-1: All FHIR elements must have a @value or children |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for structure definition (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
purpose | 0..1 | markdown | Why this structure definition is defined ele-1: All FHIR elements must have a @value or children | |
copyright | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children | |
keyword | Σ | 0..* | Coding | Assist with indexing and finding Binding: ?? (extensible): Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example). ele-1: All FHIR elements must have a @value or children |
fhirVersion | Σ | 0..1 | code | FHIR Version this StructureDefinition targets Binding: ?? (required): All published FHIR Versions. ele-1: All FHIR elements must have a @value or children |
mapping | C | 0..* | BackboneElement | External specification that the content is mapped to ele-1: All FHIR elements must have a @value or children sdf-2: Must have at least a name or a uri (or both) |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
identity | 1..1 | id | Internal id when this mapping is used ele-1: All FHIR elements must have a @value or children | |
uri | 0..1 | uri | Identifies what this mapping refers to ele-1: All FHIR elements must have a @value or children | |
name | 0..1 | string | Names what this mapping refers to ele-1: All FHIR elements must have a @value or children | |
comment | 0..1 | string | Versions, Issues, Scope limitations etc. ele-1: All FHIR elements must have a @value or children | |
kind | Σ | 1..1 | code | primitive-type | complex-type | resource | logical Binding: ?? (required): Defines the type of structure that a definition is describing. ele-1: All FHIR elements must have a @value or children |
abstract | Σ | 1..1 | boolean | Whether the structure is abstract ele-1: All FHIR elements must have a @value or children |
context | Σ | 0..* | BackboneElement | If an extension, where it can be used in instances ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
type | Σ | 1..1 | code | fhirpath | element | extension Binding: ?? (required): How an extension context is interpreted. ele-1: All FHIR elements must have a @value or children |
expression | Σ | 1..1 | string | Where the extension can be used in instances ele-1: All FHIR elements must have a @value or children |
contextInvariant | Σ | 0..* | string | FHIRPath invariants - when the extension can be used ele-1: All FHIR elements must have a @value or children |
type | Σ | 1..1 | uri | Type defined or constrained by this structure Binding: ?? (extensible): Either a resource or a data type, including logical model types. ele-1: All FHIR elements must have a @value or children |
baseDefinition | Σ | 0..1 | canonical(StructureDefinition) | Definition that this type is constrained/specialized from ele-1: All FHIR elements must have a @value or children |
derivation | Σ | 0..1 | code | specialization | constraint - How relates to base definition Binding: ?? (required): How a type relates to its baseDefinition. ele-1: All FHIR elements must have a @value or children |
snapshot | C | 0..1 | BackboneElement | Snapshot view of the structure ele-1: All FHIR elements must have a @value or children sdf-3: Each element definition in a snapshot must have a formal definition and cardinalities sdf-8: All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models sdf-8b: All snapshot elements must have a base definition |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
element | C | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) ele-1: All FHIR elements must have a @value or children sdf-10: provide either a binding reference or a description (or both) |
differential | C | 0..1 | BackboneElement | Differential view of the structure ele-1: All FHIR elements must have a @value or children sdf-20: No slicing on the root element sdf-8a: In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
element | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) ele-1: All FHIR elements must have a @value or children | |
Documentation for this format |