Structured Data Capture
4.0.0 - STU 4
Structured Data Capture
4.0.0 - STU 4
Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-library | Version: 4.0.0 | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: SDCLibrary | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.7 | ||||
Defines how a Library is used as a logic computable library.
This profile extends the CQL Library Profile to support FHIRPath expressions and FHIR query in addition to CQL as contents. Note: This profile has similar elements with the cpg-computablelibrary Profile but could not be used as the base for this profile because of its 1..1 constraint on CQL as content.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Library |
C | 1..1 | CQL Library | Represents a library of quality improvement components Constraints: lib-0, sdc-2, sdc-3 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
SΣ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| version |
SΣ | 0..1 | string | Business version of the library |
| name |
SΣC | 1..1 | string | Name for this library (computer friendly) |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
 type |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Fixed Value: As shown |
 id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
| version |
0..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: logic-library | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Logic Library | |
 userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
 subject[x] |
S | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | |
| subjectCodeableConcept |
CodeableConcept | |||
 subjectReference |
Reference(Group) | |||
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. |
| display |
SΣ | 1..1 | string | Brief description of the related artifact |
| url |
SΣ | 1..1 | url | Where the artifact can be accessed |
| parameter |
S | 0..* | ParameterDefinition | Parameters defined by the library |
| dataRequirement |
S | 0..* | DataRequirement | What data is referenced by this library |
  Slices for content |
SΣ | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType |
  content:cqlContent |
SΣ | 0..1 | Attachment | CQL Content |
  contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/cql |
 data |
S | 1..1 | base64Binary | Data inline, base64ed |
| content:fhirpathContent |
SΣ | 0..1 | Attachment | FHIRPath Content |
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/fhirpath |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
 content:queryContent |
SΣ | 0..1 | Attachment | Query Content |
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/x-fhir-query |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | |
| Library.type | extensible | Fixed Value: logic-library("Logic Library")http://hl7.org/fhir/ValueSet/library-type|4.0.1From the FHIR Standard | |
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type|4.0.1From the FHIR Standard | |
| Library.relatedArtifact.type | required | RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard | |
| Library.content:cqlContent.contentType | required | Pattern Value: text/cqlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | |
| Library.content:fhirpathContent.contentType | required | Pattern Value: text/fhirpathhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | |
| Library.content:queryContent.contentType | required | Pattern Value: application/x-fhir-queryhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | 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 | Library | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | 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() | |
| lib-0 | warning | Library | 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}') | |
| sdc-2 | error | Library | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | warning | Library | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
This structure is derived from CQL Library
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Library |
C | 1..1 | CQL Library | Represents a library of quality improvement components Constraints: sdc-2, sdc-3 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D |
 url |
S | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| version |
S | 0..1 | string | Business version of the library |
| name |
S | 1..1 | string | Name for this library (computer friendly) |
| subject[x] |
S | 0..1 | CodeableConcept, Reference(Group) | Type of individual the library content is focused on |
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
| display |
S | 1..1 | string | Brief description of the related artifact |
| url |
S | 1..1 | url | Where the artifact can be accessed |
| Slices for content |
S | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType |
| content:cqlContent |
S | 0..1 | Attachment | CQL Content |
| contentType |
S | 1..1 | code | Mime type of the content, with charset etc. Required Pattern: text/cql |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| content:fhirpathContent |
S | 0..1 | Attachment | FHIRPath Content |
| contentType |
S | 1..1 | code | Mime type of the content, with charset etc. Required Pattern: text/fhirpath |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| content:queryContent |
S | 0..1 | Attachment | Query Content |
| contentType |
S | 1..1 | code | Mime type of the content, with charset etc. Required Pattern: application/x-fhir-query |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| sdc-2 | error | Library | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | warning | Library | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Library |
C | 1..1 | CQL Library | Represents a library of quality improvement components Constraints: lib-0, sdc-2, sdc-3 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version |
SΣ | 0..1 | string | Business version of the library | ||||
| name |
SΣC | 1..1 | string | Name for this library (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the library | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| type |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Fixed Value: As shown | ||||
| id |
0..0 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension | Additional content defined by implementations | |||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..0 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |||||
| version |
0..0 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: logic-library | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Logic Library | |||||
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..0 | string | Plain text representation of the concept | |||||
| subject[x] |
S | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the library | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this library is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the library | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the library was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the library was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the library is expected to be used | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 1..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
SΣ | 1..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| parameter |
S | 0..* | ParameterDefinition | Parameters defined by the library | ||||
| dataRequirement |
S | 0..* | DataRequirement | What data is referenced by this library | ||||
| Slices for content |
SΣ | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType | ||||
| content:cqlContent |
SΣ | 0..1 | Attachment | CQL Content | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/cql | ||||
| language |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
| url |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
| content:fhirpathContent |
SΣ | 0..1 | Attachment | FHIRPath Content | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/fhirpath | ||||
| language |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
| url |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
| content:queryContent |
SΣ | 0..1 | Attachment | Query Content | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/x-fhir-query | ||||
| language |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
| url |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Library.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | ||||
| Library.type | extensible | Fixed Value: logic-library("Logic Library")http://hl7.org/fhir/ValueSet/library-type|4.0.1From the FHIR Standard | ||||
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type|4.0.1From the FHIR Standard | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction|4.0.1From the FHIR Standard | ||||
| Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic|4.0.1From the FHIR Standard | ||||
| Library.relatedArtifact.type | required | RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard | ||||
| Library.content:cqlContent.contentType | required | Pattern Value: text/cqlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | ||||
| Library.content:cqlContent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Library.content:fhirpathContent.contentType | required | Pattern Value: text/fhirpathhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | ||||
| Library.content:fhirpathContent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Library.content:queryContent.contentType | required | Pattern Value: application/x-fhir-queryhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | ||||
| Library.content:queryContent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | 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 | Library | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | 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() | |
| lib-0 | warning | Library | 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}') | |
| sdc-2 | error | Library | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | warning | Library | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
This structure is derived from CQL Library
Summary
Mandatory: 2 elements(8 nested mandatory elements)
Must-Support: 18 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Library |
C | 1..1 | CQL Library | Represents a library of quality improvement components Constraints: lib-0, sdc-2, sdc-3 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
SΣ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| version |
SΣ | 0..1 | string | Business version of the library |
| name |
SΣC | 1..1 | string | Name for this library (computer friendly) |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| type |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Fixed Value: As shown |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
| version |
0..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: logic-library | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Logic Library | |
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
| subject[x] |
S | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | |
| subjectCodeableConcept |
CodeableConcept | |||
| subjectReference |
Reference(Group) | |||
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. |
| display |
SΣ | 1..1 | string | Brief description of the related artifact |
| url |
SΣ | 1..1 | url | Where the artifact can be accessed |
| parameter |
S | 0..* | ParameterDefinition | Parameters defined by the library |
| dataRequirement |
S | 0..* | DataRequirement | What data is referenced by this library |
| Slices for content |
SΣ | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType |
| content:cqlContent |
SΣ | 0..1 | Attachment | CQL Content |
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/cql |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| content:fhirpathContent |
SΣ | 0..1 | Attachment | FHIRPath Content |
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/fhirpath |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| content:queryContent |
SΣ | 0..1 | Attachment | Query Content |
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/x-fhir-query |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | |
| Library.type | extensible | Fixed Value: logic-library("Logic Library")http://hl7.org/fhir/ValueSet/library-type|4.0.1From the FHIR Standard | |
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type|4.0.1From the FHIR Standard | |
| Library.relatedArtifact.type | required | RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard | |
| Library.content:cqlContent.contentType | required | Pattern Value: text/cqlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | |
| Library.content:fhirpathContent.contentType | required | Pattern Value: text/fhirpathhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | |
| Library.content:queryContent.contentType | required | Pattern Value: application/x-fhir-queryhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | 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 | Library | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | 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() | |
| lib-0 | warning | Library | 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}') | |
| sdc-2 | error | Library | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | warning | Library | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
Differential View
This structure is derived from CQL Library
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Library |
C | 1..1 | CQL Library | Represents a library of quality improvement components Constraints: sdc-2, sdc-3 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D |
| url |
S | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| version |
S | 0..1 | string | Business version of the library |
| name |
S | 1..1 | string | Name for this library (computer friendly) |
| subject[x] |
S | 0..1 | CodeableConcept, Reference(Group) | Type of individual the library content is focused on |
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
| display |
S | 1..1 | string | Brief description of the related artifact |
| url |
S | 1..1 | url | Where the artifact can be accessed |
| Slices for content |
S | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType |
| content:cqlContent |
S | 0..1 | Attachment | CQL Content |
| contentType |
S | 1..1 | code | Mime type of the content, with charset etc. Required Pattern: text/cql |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| content:fhirpathContent |
S | 0..1 | Attachment | FHIRPath Content |
| contentType |
S | 1..1 | code | Mime type of the content, with charset etc. Required Pattern: text/fhirpath |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| content:queryContent |
S | 0..1 | Attachment | Query Content |
| contentType |
S | 1..1 | code | Mime type of the content, with charset etc. Required Pattern: application/x-fhir-query |
| data |
S | 1..1 | base64Binary | Data inline, base64ed |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| sdc-2 | error | Library | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | warning | Library | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Library |
C | 1..1 | CQL Library | Represents a library of quality improvement components Constraints: lib-0, sdc-2, sdc-3 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version |
SΣ | 0..1 | string | Business version of the library | ||||
| name |
SΣC | 1..1 | string | Name for this library (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the library | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| type |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Fixed Value: As shown | ||||
| id |
0..0 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension | Additional content defined by implementations | |||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..0 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |||||
| version |
0..0 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: logic-library | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Logic Library | |||||
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..0 | string | Plain text representation of the concept | |||||
| subject[x] |
S | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the library | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this library is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the library | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the library was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the library was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the library is expected to be used | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 1..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
SΣ | 1..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| parameter |
S | 0..* | ParameterDefinition | Parameters defined by the library | ||||
| dataRequirement |
S | 0..* | DataRequirement | What data is referenced by this library | ||||
| Slices for content |
SΣ | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType | ||||
| content:cqlContent |
SΣ | 0..1 | Attachment | CQL Content | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/cql | ||||
| language |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
| url |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
| content:fhirpathContent |
SΣ | 0..1 | Attachment | FHIRPath Content | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/fhirpath | ||||
| language |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
| url |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
| content:queryContent |
SΣ | 0..1 | Attachment | Query Content | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/x-fhir-query | ||||
| language |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
| url |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Library.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | ||||
| Library.type | extensible | Fixed Value: logic-library("Logic Library")http://hl7.org/fhir/ValueSet/library-type|4.0.1From the FHIR Standard | ||||
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type|4.0.1From the FHIR Standard | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction|4.0.1From the FHIR Standard | ||||
| Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic|4.0.1From the FHIR Standard | ||||
| Library.relatedArtifact.type | required | RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard | ||||
| Library.content:cqlContent.contentType | required | Pattern Value: text/cqlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | ||||
| Library.content:cqlContent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Library.content:fhirpathContent.contentType | required | Pattern Value: text/fhirpathhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | ||||
| Library.content:fhirpathContent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Library.content:queryContent.contentType | required | Pattern Value: application/x-fhir-queryhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1From the FHIR Standard | ||||
| Library.content:queryContent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | 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 | Library | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | 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() | |
| lib-0 | warning | Library | 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}') | |
| sdc-2 | error | Library | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | warning | Library | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
This structure is derived from CQL Library
Summary
Mandatory: 2 elements(8 nested mandatory elements)
Must-Support: 18 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
Open Issue: Should this profile include parameter and dataRequirement? Do these elements also apply to FHIRPath and query?
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.sdc#4.0.0 based on FHIR 4.0.1. Generated 2025-09-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change