This is the set of resources that conform to either of the profiles CQL Library (http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library) and CQL Library (http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | C | 0..* | Represents a library of quality improvement components dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation clb-1: CQL libraries must one (and only one) content element that starts with 'text/cql' | |
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
identifier | Σ | 0..* | Identifier | Additional identifier for the library ele-1: All FHIR elements must have a @value or children |
version | Σ | 0..1 | string | Business version of the library ele-1: All FHIR elements must have a @value or children |
name | Σ | 0..1 | string | Name for this library (computer friendly) ele-1: All FHIR elements must have a @value or children |
title | Σ | 0..1 | string | Name for this library (human friendly) ele-1: All FHIR elements must have a @value or children |
subtitle | 0..1 | string | Subordinate title of the library ele-1: All FHIR elements must have a @value or children | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: ?? (extensible): The type of knowledge asset this library contains. ele-1: All FHIR elements must have a @value or children |
subject[x] | S | 0..1 | Type of individual the library content is focused on Binding: ?? (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). ele-1: All FHIR elements must have a @value or children | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | Σ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
description | Σ | 0..1 | markdown | Natural language description of the library ele-1: All FHIR elements must have a @value or children |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support ele-1: All FHIR elements must have a @value or children |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
purpose | 0..1 | markdown | Why this library is defined ele-1: All FHIR elements must have a @value or children | |
usage | 0..1 | string | Describes the clinical usage of the library ele-1: All FHIR elements must have a @value or children | |
copyright | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children | |
approvalDate | 0..1 | date | When the library was approved by publisher ele-1: All FHIR elements must have a @value or children | |
lastReviewDate | 0..1 | date | When the library was last reviewed ele-1: All FHIR elements must have a @value or children | |
effectivePeriod | Σ | 0..1 | Period | When the library is expected to be used ele-1: All FHIR elements must have a @value or children |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: ?? (example): High-level categorization of the definition, used for searching, sorting, and filtering. ele-1: All FHIR elements must have a @value or children | |
author | 0..* | ContactDetail | Who authored the content ele-1: All FHIR elements must have a @value or children | |
editor | 0..* | ContactDetail | Who edited the content ele-1: All FHIR elements must have a @value or children | |
reviewer | 0..* | ContactDetail | Who reviewed the content ele-1: All FHIR elements must have a @value or children | |
endorser | 0..* | ContactDetail | Who endorsed the content ele-1: All FHIR elements must have a @value or children | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. ele-1: All FHIR elements must have a @value or children | |
parameter | 0..* | ParameterDefinition | Parameters defined by the library ele-1: All FHIR elements must have a @value or children | |
dataRequirement | 0..* | DataRequirement | What data is referenced by this library ele-1: All FHIR elements must have a @value or children | |
content | SΣC | 1..* | Attachment | Contents of the library, either embedded or referenced ele-1: All FHIR elements must have a @value or children clb-2: CQL libraries must have a content element with data or a url (or both) |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png |
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children Example General: en-AU |
data | S | 0..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children |
url | SΣ | 0..1 | url | Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png |
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) ele-1: All FHIR elements must have a @value or children |
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children |
title | Σ | 0..1 | string | Label to display in place of the data ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo |
creation | Σ | 0..1 | dateTime | Date attachment was first created ele-1: All FHIR elements must have a @value or children |
Documentation for this format |