R6 Ballot (1st Draft)
Clinical ReasoningThis page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Use Context: Country: World |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/elmlibrary
Represents an executable CQL logic library in translated ELM format
This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from LogicLibrary.
Summary
Mandatory: 0 element (+2 nested mandatory elements)
Must-Support: 7 elements
Fixed Value: 2 elements
Slices
This structure defines the following Slices:
This indicates the differences between this profile and the base LogicLibrary structure.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Library | 1..1 | LogicLibrary | Represents a library of quality improvement components | |
  Slices for content | S | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType |
   content:elmXmlContent | S | 0..* | Attachment | ELM XML Content |
   contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/elm+xml |
  data | S | 1..1 | base64Binary | Data inline, base64ed |
 content:elmJsonContent | S | 0..* | Attachment | ELM JSON Content |
| contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/elm+json |
| data | S | 1..1 | base64Binary | Data inline, base64ed |
| Documentation for this format | ||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base LogicLibrary structure.
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Library | C | 1..1 | LogicLibrary | Represents a library of quality improvement components | ||||
 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: All Languages (required): IETF language tag for 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: Knowledge Capability Value Set (required) | ||||
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) | ||||
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
| directReferenceCode | S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode | ||||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | SΣC | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version | SΣ | 1..1 | string | Business version of the library | ||||
  versionAlgorithm[x] | SΣ | 0..1 | How to compare versions Binding: Version Algorithm (extensible) | |||||
 versionAlgorithmString | string | |||||||
 versionAlgorithmCoding | Coding | |||||||
| name | SΣC | 0..1 | string | Name for this library (computer friendly) | ||||
| title | SΣ | 1..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 | SΣ | 0..1 | boolean | For testing purposes, not real usage | ||||
| type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: Library Type (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: module-definition | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| subject[x] | S | 0..1 | Type of individual the library content is focused on Binding: Participant Resource Types (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 | SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | SΣ | 1..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 | markdown | Describes the clinical usage of the library | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
| approvalDate | 0..1 | date | When the library was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the library was last reviewed by the publisher | |||||
| effectivePeriod | Σ | 0..1 | Period | When the library is expected to be used | ||||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (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 | |||||
| Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc Slice: Unordered, Open by value:type | ||||
| relatedArtifact:dependency | S | 0..* | RelatedArtifact | Additional documentation, citations, etc | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type | SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on | ||||
| classifier | Σ | 0..* | CodeableConcept | Additional classifiers Binding: Citation Artifact Classifier (example): Additional classifiers for the related artifact. | ||||
| label | Σ | 0..1 | string | Short label | ||||
| display | Σ | 0..1 | string | Brief description of the related artifact | ||||
| citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| document | Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource | SΣ | 1..1 | canonical(CodeSystem | ValueSet | Library) | What artifact is being referenced | ||||
| resourceReference | Σ | 0..1 | Reference(Resource) | What artifact, if not a conformance resource | ||||
| publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to. | ||||
| publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to | ||||
| 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:All Slices | Content/Rules for all slices | |||||||
 id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | SΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: All Languages (required): IETF language tag for a human language.
Example General: en-AU | ||||
| data | SC | 0..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 | integer64 | 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 | ||||
| height | 0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
| width | 0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
| frames | 0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
| duration | 0..1 | decimal | Length in seconds (audio / video) | |||||
 pages | 0..1 | positiveInt | Number of printed pages | |||||
| content:elmXmlContent | SΣ | 0..* | Attachment | ELM XML Content | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | SΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Fixed Value: application/elm+xml | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: All Languages (required): IETF language tag for a human language.
Example General: en-AU | ||||
| data | SC | 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 | integer64 | 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 | ||||
| height | 0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
| width | 0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
| frames | 0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
| duration | 0..1 | decimal | Length in seconds (audio / video) | |||||
| pages | 0..1 | positiveInt | Number of printed pages | |||||
| content:elmJsonContent | SΣ | 0..* | Attachment | ELM JSON Content | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | SΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Fixed Value: application/elm+json | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: All Languages (required): IETF language tag for a human language.
Example General: en-AU | ||||
| data | SC | 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 | integer64 | 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 | ||||
| height | 0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
| width | 0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
| frames | 0..1 | positiveInt | Number of frames if > 1 (photo) | |||||