Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablestructuredefinition | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: CRMIPublishableStructureDefinition | ||
Supports declaration of the StructureDefinition metadata required by HL7 and other organizations that share and publish structure definitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CRMIShareableStructureDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  StructureDefinition | C | 1..1 | CRMIShareableStructureDefinition | Structural Definition |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapabilityValues (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact |
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact |
| usage | S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage |
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) |
 identifier | SΣ | 0..* | Identifier | Additional identifier for the structure definition |
| version | SΣ | 1..1 | string | Business version of the structure definition |
| name | SΣC | 1..1 | string | Name for this structure definition (computer friendly) |
| title | SΣ | 1..1 | string | Name for this structure definition (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
| date | SΣ | 1..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 1..1 | markdown | Natural language description of the structure definition |
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for structure definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| purpose | S | 0..1 | markdown | Why this structure definition is defined |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| kind | Σ | 1..1 | code | primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. |
| abstract | Σ | 1..1 | boolean | Whether the structure is abstract |
 type | ΣC | 1..1 | uri | Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| StructureDefinition.status | required | PublicationStatus |
| StructureDefinition.jurisdiction | extensible | Jurisdiction ValueSet |
| StructureDefinition.kind | required | StructureDefinitionKind |
| StructureDefinition.type | extensible | FHIRDefinedType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | StructureDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | StructureDefinition | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | StructureDefinition | 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() | |
| dom-5 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | StructureDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| sdf-0 | warning | StructureDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| sdf-1 | error | StructureDefinition | Element paths must be unique unless the structure is a constraint : derivation = 'constraint' or snapshot.element.select(path).isDistinct() | |
| sdf-6 | error | StructureDefinition | A structure must have either a differential, or a snapshot (or both) : snapshot.exists() or differential.exists() | |
| sdf-14 | error | StructureDefinition | All element definitions must have an id : snapshot.element.all(id.exists()) and differential.element.all(id.exists()) | elements have id |
| sdf-15a | error | StructureDefinition | If the first element in a differential has no "." in the path and it's not a logical model, it has no type : (kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty() | No Type on the root element (differential) |
| sdf-4 | error | StructureDefinition | If the structure is not abstract, then there SHALL be a baseDefinition : abstract = true or baseDefinition.exists() | Ensure that the base types are abstract |
| sdf-5 | error | StructureDefinition | If the structure defines an extension then the structure must have context information : type != 'Extension' or derivation = 'specialization' or (context.exists()) | |
| sdf-9 | error | StructureDefinition | In any snapshot or differential, no label, code or requirements on 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() | Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition |
| sdf-11 | error | StructureDefinition | If there's a type, its content must match the path name in the first element of a snapshot : kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type | Ensure that the type is not inconsistent with the other information in the structure |
| sdf-15 | error | StructureDefinition | The first element in a snapshot has no type unless model is a logical model. : kind!='logical' implies snapshot.element.first().type.empty() | No Type on the root element (snapshot) |
| sdf-16 | error | StructureDefinition | All element definitions must have unique ids (snapshot) : snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct() | element ids need to be unique |
| sdf-17 | error | StructureDefinition | All element definitions must have unique ids (diff) : differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct() | element ids need to be unique |
| sdf-18 | error | StructureDefinition | Context Invariants can only be used for extensions : contextInvariant.exists() implies type = 'Extension' | contextInvariant |
| sdf-19 | error | StructureDefinition | FHIR Specification models only use FHIR defined types : url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential.element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')) and snapshot.element.type.code.all(matches('^[a-zA-Z0-9\\.]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$'))) | custom types only in logical models |
| sdf-21 | error | StructureDefinition | Default values can only be specified on specializations : differential.element.defaultValue.exists() implies (derivation = 'specialization') | no default values on data types or resources |
| sdf-22 | error | StructureDefinition | FHIR Specification models never have default values : url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty()) | no default values on data types or resources |
| sdf-23 | error | StructureDefinition | No slice name on root : (snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty()) | no sliceName on root |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| StructureDefinition | C | 1..1 | CRMIShareableStructureDefinition | Structural Definition | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapabilityValues (required) | ||||
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) | ||||
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact | ||||
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact | ||||
| usage | S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | SΣ | 1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) | ||||
| identifier | SΣ | 0..* | Identifier | Additional identifier for the structure definition | ||||
| version | SΣ | 1..1 | string | Business version of the structure definition | ||||
| name | SΣC | 1..1 | string | Name for this structure definition (computer friendly) | ||||
| title | SΣ | 1..1 | string | Name for this structure definition (human friendly) | ||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date | SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 1..1 | markdown | Natural language description of the structure definition | ||||
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for structure definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | S | 0..1 | markdown | Why this structure definition is defined | ||||
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions | ||||
| keyword | Σ | 0..* | Coding | Assist with indexing and finding Binding: DefinitionUseCodes (extensible): Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example). | ||||
| fhirVersion | Σ | 0..1 | code | FHIR Version this StructureDefinition targets Binding: FHIRVersion (required): All published FHIR Versions. | ||||
 mapping | C | 0..* | BackboneElement | External specification that the content is mapped to | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identity | 1..1 | id | Internal id when this mapping is used | |||||
| uri | C | 0..1 | uri | Identifies what this mapping refers to | ||||
| name | C | 0..1 | string | Names what this mapping refers to | ||||
| comment | 0..1 | string | Versions, Issues, Scope limitations etc. | |||||
| kind | Σ | 1..1 | code | primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. | ||||
| abstract | Σ | 1..1 | boolean | Whether the structure is abstract | ||||
| context | ΣC | 0..* | BackboneElement | If an extension, where it can be used in instances | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..1 | code | fhirpath | element | extension Binding: ExtensionContextType (required): How an extension context is interpreted. | ||||
| expression | Σ | 1..1 | string | Where the extension can be used in instances | ||||
| contextInvariant | ΣC | 0..* | string | FHIRPath invariants - when the extension can be used | ||||
| type | ΣC | 1..1 | uri | Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| baseDefinition | ΣC | 0..1 | canonical(StructureDefinition) | Definition that this type is constrained/specialized from | ||||
| derivation | Σ | 0..1 | code | specialization | constraint - How relates to base definition Binding: TypeDerivationRule (required): How a type relates to its baseDefinition. | ||||
| snapshot | C | 0..1 | BackboneElement | Snapshot view of the structure | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| element | C | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) | ||||
 differential | C | 0..1 | BackboneElement | Differential view of the structure | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| element | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| StructureDefinition.language | preferred | CommonLanguages
| ||||
| StructureDefinition.status | required | PublicationStatus | ||||
| StructureDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| StructureDefinition.keyword | extensible | DefinitionUseCodes | ||||
| StructureDefinition.fhirVersion | required | FHIRVersion | ||||
| StructureDefinition.kind | required | StructureDefinitionKind | ||||
| StructureDefinition.context.type | required | ExtensionContextType | ||||
| StructureDefinition.type | extensible | FHIRDefinedType | ||||
| StructureDefinition.derivation | required | TypeDerivationRule |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| sdf-2 | error | StructureDefinition.mapping | Must have at least a name or a uri (or both) : name.exists() or uri.exists() | |
| sdf-3 | error | StructureDefinition.snapshot | Each element definition in a snapshot must have a formal definition and cardinalities : element.all(definition.exists() and min.exists() and max.exists()) | |
| sdf-8 | error | StructureDefinition.snapshot | All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models : (%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.')) | |
| sdf-10 | error | StructureDefinition.snapshot.element | provide either a binding reference or a description (or both) : binding.empty() or binding.valueSet.exists() or binding.description.exists() | binding is required |
| sdf-20 | error | StructureDefinition.differential | No slicing on the root element : element.where(path.contains('.').not()).slicing.empty() | no slicing on root |
| sdf-8a | error | StructureDefinition.differential | 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 : (%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\..*','')&'.'))) | |
| sdf-8b | error | StructureDefinition.snapshot | All snapshot elements must have a base definition : element.all(base.exists()) |
This structure is derived from CRMIShareableStructureDefinition
Summary
Mandatory: 1 element
Must-Support: 18 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Differential View
This structure is derived from CRMIShareableStructureDefinition
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| StructureDefinition | C | 1..1 | CRMIShareableStructureDefinition | Structural Definition |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapabilityValues (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact |
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact |
| usage | S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage |
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) |
| identifier | SΣ | 0..* | Identifier | Additional identifier for the structure definition |
| version | SΣ | 1..1 | string | Business version of the structure definition |
| name | SΣC | 1..1 | string | Name for this structure definition (computer friendly) |
| title | SΣ | 1..1 | string | Name for this structure definition (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
| date | SΣ | 1..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 1..1 | markdown | Natural language description of the structure definition |
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for structure definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| purpose | S | 0..1 | markdown | Why this structure definition is defined |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| kind | Σ | 1..1 | code | primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. |
| abstract | Σ | 1..1 | boolean | Whether the structure is abstract |
| type | ΣC | 1..1 | uri | Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| StructureDefinition.status | required | PublicationStatus |
| StructureDefinition.jurisdiction | extensible | Jurisdiction ValueSet |
| StructureDefinition.kind | required | StructureDefinitionKind |
| StructureDefinition.type | extensible | FHIRDefinedType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | StructureDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | StructureDefinition | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | StructureDefinition | 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() | |
| dom-5 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | StructureDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| sdf-0 | warning | StructureDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| sdf-1 | error | StructureDefinition | Element paths must be unique unless the structure is a constraint : derivation = 'constraint' or snapshot.element.select(path).isDistinct() | |
| sdf-6 | error | StructureDefinition | A structure must have either a differential, or a snapshot (or both) : snapshot.exists() or differential.exists() | |
| sdf-14 | error | StructureDefinition | All element definitions must have an id : snapshot.element.all(id.exists()) and differential.element.all(id.exists()) | elements have id |
| sdf-15a | error | StructureDefinition | If the first element in a differential has no "." in the path and it's not a logical model, it has no type : (kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty() | No Type on the root element (differential) |
| sdf-4 | error | StructureDefinition | If the structure is not abstract, then there SHALL be a baseDefinition : abstract = true or baseDefinition.exists() | Ensure that the base types are abstract |
| sdf-5 | error | StructureDefinition | If the structure defines an extension then the structure must have context information : type != 'Extension' or derivation = 'specialization' or (context.exists()) | |
| sdf-9 | error | StructureDefinition | In any snapshot or differential, no label, code or requirements on 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() | Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition |
| sdf-11 | error | StructureDefinition | If there's a type, its content must match the path name in the first element of a snapshot : kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type | Ensure that the type is not inconsistent with the other information in the structure |
| sdf-15 | error | StructureDefinition | The first element in a snapshot has no type unless model is a logical model. : kind!='logical' implies snapshot.element.first().type.empty() | No Type on the root element (snapshot) |
| sdf-16 | error | StructureDefinition | All element definitions must have unique ids (snapshot) : snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct() | element ids need to be unique |
| sdf-17 | error | StructureDefinition | All element definitions must have unique ids (diff) : differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct() | element ids need to be unique |
| sdf-18 | error | StructureDefinition | Context Invariants can only be used for extensions : contextInvariant.exists() implies type = 'Extension' | contextInvariant |
| sdf-19 | error | StructureDefinition | FHIR Specification models only use FHIR defined types : url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential.element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')) and snapshot.element.type.code.all(matches('^[a-zA-Z0-9\\.]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$'))) | custom types only in logical models |
| sdf-21 | error | StructureDefinition | Default values can only be specified on specializations : differential.element.defaultValue.exists() implies (derivation = 'specialization') | no default values on data types or resources |
| sdf-22 | error | StructureDefinition | FHIR Specification models never have default values : url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty()) | no default values on data types or resources |
| sdf-23 | error | StructureDefinition | No slice name on root : (snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty()) | no sliceName on root |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| StructureDefinition | C | 1..1 | CRMIShareableStructureDefinition | Structural Definition | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapabilityValues (required) | ||||
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) | ||||
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact | ||||
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact | ||||
| usage | S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | SΣ | 1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) | ||||
| identifier | SΣ | 0..* | Identifier | Additional identifier for the structure definition | ||||
| version | SΣ | 1..1 | string | Business version of the structure definition | ||||
| name | SΣC | 1..1 | string | Name for this structure definition (computer friendly) | ||||
| title | SΣ | 1..1 | string | Name for this structure definition (human friendly) | ||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date | SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 1..1 | markdown | Natural language description of the structure definition | ||||
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for structure definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | S | 0..1 | markdown | Why this structure definition is defined | ||||
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions | ||||
| keyword | Σ | 0..* | Coding | Assist with indexing and finding Binding: DefinitionUseCodes (extensible): Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example). | ||||
| fhirVersion | Σ | 0..1 | code | FHIR Version this StructureDefinition targets Binding: FHIRVersion (required): All published FHIR Versions. | ||||
| mapping | C | 0..* | BackboneElement | External specification that the content is mapped to | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identity | 1..1 | id | Internal id when this mapping is used | |||||
| uri | C | 0..1 | uri | Identifies what this mapping refers to | ||||
| name | C | 0..1 | string | Names what this mapping refers to | ||||
| comment | 0..1 | string | Versions, Issues, Scope limitations etc. | |||||
| kind | Σ | 1..1 | code | primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. | ||||
| abstract | Σ | 1..1 | boolean | Whether the structure is abstract | ||||
| context | ΣC | 0..* | BackboneElement | If an extension, where it can be used in instances | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..1 | code | fhirpath | element | extension Binding: ExtensionContextType (required): How an extension context is interpreted. | ||||
| expression | Σ | 1..1 | string | Where the extension can be used in instances | ||||
| contextInvariant | ΣC | 0..* | string | FHIRPath invariants - when the extension can be used | ||||
| type | ΣC | 1..1 | uri | Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| baseDefinition | ΣC | 0..1 | canonical(StructureDefinition) | Definition that this type is constrained/specialized from | ||||
| derivation | Σ | 0..1 | code | specialization | constraint - How relates to base definition Binding: TypeDerivationRule (required): How a type relates to its baseDefinition. | ||||
| snapshot | C | 0..1 | BackboneElement | Snapshot view of the structure | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| element | C | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) | ||||
| differential | C | 0..1 | BackboneElement | Differential view of the structure | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| element | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| StructureDefinition.language | preferred | CommonLanguages
| ||||
| StructureDefinition.status | required | PublicationStatus | ||||
| StructureDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| StructureDefinition.keyword | extensible | DefinitionUseCodes | ||||
| StructureDefinition.fhirVersion | required | FHIRVersion | ||||
| StructureDefinition.kind | required | StructureDefinitionKind | ||||
| StructureDefinition.context.type | required | ExtensionContextType | ||||
| StructureDefinition.type | extensible | FHIRDefinedType | ||||
| StructureDefinition.derivation | required | TypeDerivationRule |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| sdf-2 | error | StructureDefinition.mapping | Must have at least a name or a uri (or both) : name.exists() or uri.exists() | |
| sdf-3 | error | StructureDefinition.snapshot | Each element definition in a snapshot must have a formal definition and cardinalities : element.all(definition.exists() and min.exists() and max.exists()) | |
| sdf-8 | error | StructureDefinition.snapshot | All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models : (%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.')) | |
| sdf-10 | error | StructureDefinition.snapshot.element | provide either a binding reference or a description (or both) : binding.empty() or binding.valueSet.exists() or binding.description.exists() | binding is required |
| sdf-20 | error | StructureDefinition.differential | No slicing on the root element : element.where(path.contains('.').not()).slicing.empty() | no slicing on root |
| sdf-8a | error | StructureDefinition.differential | 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 : (%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\..*','')&'.'))) | |
| sdf-8b | error | StructureDefinition.snapshot | All snapshot elements must have a base definition : element.all(base.exists()) |
This structure is derived from CRMIShareableStructureDefinition
Summary
Mandatory: 1 element
Must-Support: 18 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ Clinical Decision Support WG. Package hl7.fhir.uv.crmi#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-08-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
