Release 5 Draft Ballot
Clinical ReasoningThis page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this 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 official 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 structure is derived from LogicLibrary.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Library | 1..1 | LogicLibrary | Represents a library of quality improvement components | |
  content | S | 0..* | (Slice Definition) | 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | I | 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: Common Languages (preferred) Max Binding: All Languages: IETF language tag | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cqf-knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability (required) |
| cqf-knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
| cqf-artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| cqf-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 | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| identifier | SΣ | 0..* | Identifier | Additional identifier for the library |
| version | Σ | 1..1 | string | Business version of the library |
| name | ΣI | 1..1 | string | Name for this library (computer friendly) |
| title | SΣ | 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 | Σ | 1..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. 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: Subject type (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | |
| subjectCodeableConcept | CodeableConcept | |||
 subjectReference | Reference(Group) | |||
| date | SΣ | 0..1 | dateTime | Date last changed |
| publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | Σ | 1..1 | markdown | Natural language description of the library |
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction (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..* | (Slice Definition) | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:dependency | 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 | SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) Fixed Value: depends-on |
| 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 |
| url | Σ | 0..1 | url | Where the artifact can be accessed |
| document | Σ | 0..1 | Attachment | What document is being referenced |
| resource | SΣ | 1..1 | canonical(CodeSystem | ValueSet | Library) | 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 |
| content | SΣ | 0..* | (Slice Definition) | 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 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (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: Common Languages (preferred) Max Binding: All Languages: IETF language tag Example General: en-AU |
| data | S | 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 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (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: Common Languages (preferred) Max Binding: All Languages: IETF language tag 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 | 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 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (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: Common Languages (preferred) Max Binding: All Languages: IETF language tag 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 | 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 | |
| Documentation for this format | ||||
<!-- ELMLibrary --><Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!--
0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
{ // ELMLibrary
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // shareable | computable | publishable | executable // C?
// from Element: extension
},
{ // narrative | semi-structured | structured | executable // C?
// from Element: extension
},
{ // Additional documentation, review, or usage guidance // C?
// from Element: extension
},
{ // A code directly referenced by the artifact // C?
// from Element: extension
}
],
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"url" : "<uri>", // C? R! Canonical identifier for this library, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the library
"version" : "<string>", // C? R! Business version of the library
"name" : "<string>", // C? R! Name for this library (computer friendly)
"title" : "<string>", // C?Name for this library (human friendly)
"subtitle" : "<string>", // C?Subordinate title of the library
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C? R! For testing purposes, not real usage
"type" : { CodeableConcept }, // C? R! logic-library | model-definition | asset-collection | module-definition
// value[x]: Type of individual the library content is focused on. One of these 2:
"subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on
"subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C? R! Natural language description of the library
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable)
"purpose" : "<markdown>", // C?Why this library is defined
"usage" : "<string>", // C?Describes the clinical usage of the library
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"approvalDate" : "<date>", // C?When the library was approved by publisher
"lastReviewDate" : "<date>", // C?When the library was last reviewed
"effectivePeriod" : { Period }, // C?When the library is expected to be used
"topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
"author" : [{ ContactDetail }], // C?Who authored the content
"editor" : [{ ContactDetail }], // C?Who edited the content
"reviewer" : [{ ContactDetail }], // C?Who reviewed the content
"endorser" : [{ ContactDetail }], // C?Who endorsed the content
"relatedArtifact" : [ // sliced by value:type in the specified order, Open
{ // Additional documentation, citations, etc. // C?
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"type" : "depends-on", // C? R!
"label" : "<string>", // C?Short label
"display" : "<string>", // C?Brief description of the related artifact
"citation" : "<markdown>", // C?Bibliographic citation for the artifact
"url" : "<url>", // C?Where the artifact can be accessed
"document" : { Attachment }, // C?What document is being referenced
"resource" : "<canonical>" // C? R! What resource is being referenced
}
],
"parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library
"dataRequirement" : [{ DataRequirement }], // C?What data is referenced by this library
"content" : [ // sliced by value:contentType in the specified order, Open
{ // ELM XML Content // C?
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"contentType" : "application/elm+xml", // C?
"language" : "<code>", // C?Human language of the content (BCP-47)
"data" : "<base64Binary>", // C? R! Data inline, base64ed
"url" : "<url>", // C?Uri where the data can be found
"size" : "<integer64>", // C?Number of bytes of content (if url provided)
"hash" : "<base64Binary>", // C?Hash of the data (sha-1, base64ed)
"title" : "<string>", // C?Label to display in place of the data
"creation" : "<dateTime>", // C?Date attachment was first created
"height" : "<positiveInt>", // C?Height of the image in pixels (photo/video)
"width" : "<positiveInt>", // C?Width of the image in pixels (photo/video)
"frames" : "<positiveInt>", // C?Number of frames if > 1 (photo)
"duration" : <decimal>, // C?Length in seconds (audio / video)
"pages" : "<positiveInt>" // C?Number of printed pages
},
{ // ELM JSON Content // C?
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"contentType" : "application/elm+json", // C?
"language" : "<code>", // C?Human language of the content (BCP-47)
"data" : "<base64Binary>", // C? R! Data inline, base64ed
"url" : "<url>", // C?Uri where the data can be found
"size" : "<integer64>", // C?Number of bytes of content (if url provided)
"hash" : "<base64Binary>", // C?Hash of the data (sha-1, base64ed)
"title" : "<string>", // C?Label to display in place of the data
"creation" : "<dateTime>", // C?Date attachment was first created
"height" : "<positiveInt>", // C?Height of the image in pixels (photo/video)
"width" : "<positiveInt>", // C?Width of the image in pixels (photo/video)
"frames" : "<positiveInt>", // C?Number of frames if > 1 (photo)
"duration" : <decimal>, // C?Length in seconds (audio / video)
"pages" : "<positiveInt>" // C?Number of printed pages
}
],
}
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:
Differential View
This structure is derived from LogicLibrary.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | 1..1 | LogicLibrary | Represents a library of quality improvement components | |
| content | S | 0..* | (Slice Definition) | 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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | I | 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: Common Languages (preferred) Max Binding: All Languages: IETF language tag | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cqf-knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability (required) |
| cqf-knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level (required) |
| cqf-artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| cqf-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 | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| identifier | SΣ | 0..* | Identifier | Additional identifier for the library |
| version | Σ | 1..1 | string | Business version of the library |
| name | ΣI | 1..1 | string | Name for this library (computer friendly) |
| title | SΣ | 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 | Σ | 1..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. 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: Subject type (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | |
| subjectCodeableConcept | CodeableConcept | |||
| subjectReference | Reference(Group) | |||
| date | SΣ | 0..1 | dateTime | Date last changed |
| publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | Σ | 1..1 | markdown | Natural language description of the library |
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction (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..* | (Slice Definition) | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:dependency | 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 | SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) Fixed Value: depends-on |
| 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 |
| url | Σ | 0..1 | url | Where the artifact can be accessed |
| document | Σ | 0..1 | Attachment | What document is being referenced |
| resource | SΣ | 1..1 | canonical(CodeSystem | ValueSet | Library) | 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 |
| content | SΣ | 0..* | (Slice Definition) | 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 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (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: Common Languages (preferred) Max Binding: All Languages: IETF language tag Example General: en-AU |
| data | S | 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 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (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: Common Languages (preferred) Max Binding: All Languages: IETF language tag 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 | 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 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (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: Common Languages (preferred) Max Binding: All Languages: IETF language tag 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 | 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 | |
| Documentation for this format | ||||
XML Template
<!-- ELMLibrary -->
JSON Template
{ // ELMLibrary
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // shareable | computable | publishable | executable // C?
// from Element: extension
},
{ // narrative | semi-structured | structured | executable // C?
// from Element: extension
},
{ // Additional documentation, review, or usage guidance // C?
// from Element: extension
},
{ // A code directly referenced by the artifact // C?
// from Element: extension
}
],
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"url" : "<uri>", // C? R! Canonical identifier for this library, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the library
"version" : "<string>", // C? R! Business version of the library
"name" : "<string>", // C? R! Name for this library (computer friendly)
"title" : "<string>", // C?Name for this library (human friendly)
"subtitle" : "<string>", // C?Subordinate title of the library
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C? R! For testing purposes, not real usage
"type" : { CodeableConcept }, // C? R! logic-library | model-definition | asset-collection | module-definition
// value[x]: Type of individual the library content is focused on. One of these 2:
"subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on
"subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C? R! Natural language description of the library
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable)
"purpose" : "<markdown>", // C?Why this library is defined
"usage" : "<string>", // C?Describes the clinical usage of the library
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"approvalDate" : "<date>", // C?When the library was approved by publisher
"lastReviewDate" : "<date>", // C?When the library was last reviewed
"effectivePeriod" : { Period }, // C?When the library is expected to be used
"topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
"author" : [{ ContactDetail }], // C?Who authored the content
"editor" : [{ ContactDetail }], // C?Who edited the content
"reviewer" : [{ ContactDetail }], // C?Who reviewed the content
"endorser" : [{ ContactDetail }], // C?Who endorsed the content
"relatedArtifact" : [ // sliced by value:type in the specified order, Open
{ // Additional documentation, citations, etc. // C?
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"type" : "depends-on", // C? R!
"label" : "<string>", // C?Short label
"display" : "<string>", // C?Brief description of the related artifact
"citation" : "<markdown>", // C?Bibliographic citation for the artifact
"url" : "<url>", // C?Where the artifact can be accessed
"document" : { Attachment }, // C?What document is being referenced
"resource" : "<canonical>" // C? R! What resource is being referenced
}
],
"parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library
"dataRequirement" : [{ DataRequirement }], // C?What data is referenced by this library
"content" : [ // sliced by value:contentType in the specified order, Open
{ // ELM XML Content // C?
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"contentType" : "application/elm+xml", // C?
"language" : "<code>", // C?Human language of the content (BCP-47)
"data" : "<base64Binary>", // C? R! Data inline, base64ed
"url" : "<url>", // C?Uri where the data can be found
"size" : "<integer64>", // C?Number of bytes of content (if url provided)
"hash" : "<base64Binary>", // C?Hash of the data (sha-1, base64ed)
"title" : "<string>", // C?Label to display in place of the data
"creation" : "<dateTime>", // C?Date attachment was first created
"height" : "<positiveInt>", // C?Height of the image in pixels (photo/video)
"width" : "<positiveInt>", // C?Width of the image in pixels (photo/video)
"frames" : "<positiveInt>", // C?Number of frames if > 1 (photo)
"duration" : <decimal>, // C?Length in seconds (audio / video)
"pages" : "<positiveInt>" // C?Number of printed pages
},
{ // ELM JSON Content // C?
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"contentType" : "application/elm+json", // C?
"language" : "<code>", // C?Human language of the content (BCP-47)
"data" : "<base64Binary>", // C? R! Data inline, base64ed
"url" : "<url>", // C?Uri where the data can be found
"size" : "<integer64>", // C?Number of bytes of content (if url provided)
"hash" : "<base64Binary>", // C?Hash of the data (sha-1, base64ed)
"title" : "<string>", // C?Label to display in place of the data
"creation" : "<dateTime>", // C?Date attachment was first created
"height" : "<positiveInt>", // C?Height of the image in pixels (photo/video)
"width" : "<positiveInt>", // C?Width of the image in pixels (photo/video)
"frames" : "<positiveInt>", // C?Number of frames if > 1 (photo)
"duration" : <decimal>, // C?Length in seconds (audio / video)
"pages" : "<positiveInt>" // C?Number of printed pages
}
],
}
Alternate definitions: Master Definition (XML, JSON), Schematron
| Path | Name | Conformance | ValueSet |
| Library.language | Common Languages | preferred | Common Languages |
| Library.status | PublicationStatus | required | PublicationStatus |
| Library.type | LibraryType | extensible | LibraryType |
| Library.subject[x] | Subject type | extensible | Subject type |
| Library.jurisdiction | Jurisdiction | extensible | Jurisdiction |
| Library.topic | DefinitionTopic | example | DefinitionTopic |
| Library.relatedArtifact.type | RelatedArtifactType | required | RelatedArtifactType |
| Library.content.contentType | MimeType | required | MimeType |
| Library.content.language | Common Languages | preferred | Common Languages |
| Library.content.contentType | MimeType | required | MimeType |
| Library.content.language | Common Languages | preferred | Common Languages |
| Library.content.contentType | MimeType | required | MimeType |
| Library.content.language | Common Languages | preferred | Common Languages |
FHIR ®© HL7.org 2011+. FHIR R5 Draft Ballot hl7.fhir.core#4.6.0 generated on Thu, Apr 15, 2021 12:29+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change