Publish-box (todo)
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/modelinfolibrary
Represents a computable representation of a model information library
This profile was published on Thu, Jan 1, 1970 00:00+0800 as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from ShareableLibrary.
Summary
Mandatory: 1 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 ShareableLibrary structure.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | ShareableLibrary | Represents a library of quality improvement components | |
type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: model-definition | |
Slices for content | S | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType |
content:modelInfoXmlContent | S | 0..* | Attachment | ModelInfo XML Content |
contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/xml |
data | S | 1..1 | base64Binary | Data inline, base64ed |
content:modelInfoJsonContent | S | 0..* | Attachment | ModelInfo JSON Content |
contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/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 ShareableLibrary structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Library | C | 1..1 | ShareableLibrary | Represents a library of quality improvement components cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
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 | ||||
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) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
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: model-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] | 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 | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |||||
dataRequirement | 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:modelInfoXmlContent | SΣ | 0..* | Attachment | ModelInfo 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/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:modelInfoJsonContent | SΣ | 0..* | Attachment | ModelInfo 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/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) | |||||
duration | 0..1 | decimal | Length in seconds (audio / video) | |||||
pages | 0..1 | positiveInt | Number of printed pages | |||||
Documentation for this format |
<!-- ModelInfoLibrary --> <Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the library --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the library --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this library (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this library (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the library --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage --> <type><!-- I 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the library --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this library is defined --> <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the library was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the library was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the library is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <parameter><!-- I 0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!-- I 0..* DataRequirement What data is referenced by this library --></dataRequirement> <-- content sliced by value:contentType in the specified orderOpen--> <content> I 0..* Attachment <!-- I 0..* ModelInfo XML Content --> <contentType value="[code]"/><!-- I 0..1 Mime type of the content, with charset etc. --> <language value="[code]"/><!-- I 0..1 Human language of the content (BCP-47) --> <data value="[base64Binary]"/><!-- I 1..1 Data inline, base64ed --> <url value="[url]"/><!-- I 0..1 Uri where the data can be found --> <size value="[integer64]"/><!-- I 0..1 Number of bytes of content (if url provided) --> <hash value="[base64Binary]"/><!-- I 0..1 Hash of the data (sha-1, base64ed) --> <title value="[string]"/><!-- I 0..1 Label to display in place of the data --> <creation value="[dateTime]"/><!-- I 0..1 Date attachment was first created --> <height value="[positiveInt]"/><!-- I 0..1 Height of the image in pixels (photo/video) --> <width value="[positiveInt]"/><!-- I 0..1 Width of the image in pixels (photo/video) --> <frames value="[positiveInt]"/><!-- I 0..1 Number of frames if > 1 (photo) --> <duration value="[decimal]"/><!-- I 0..1 Length in seconds (audio / video) --> <pages value="[positiveInt]"/><!-- I 0..1 Number of printed pages --> </content> <content> I 0..* Attachment <!-- I 0..* ModelInfo JSON Content --> <contentType value="[code]"/><!-- I 0..1 Mime type of the content, with charset etc. --> <language value="[code]"/><!-- I 0..1 Human language of the content (BCP-47) --> <data value="[base64Binary]"/><!-- I 1..1 Data inline, base64ed --> <url value="[url]"/><!-- I 0..1 Uri where the data can be found --> <size value="[integer64]"/><!-- I 0..1 Number of bytes of content (if url provided) --> <hash value="[base64Binary]"/><!-- I 0..1 Hash of the data (sha-1, base64ed) --> <title value="[string]"/><!-- I 0..1 Label to display in place of the data --> <creation value="[dateTime]"/><!-- I 0..1 Date attachment was first created --> <height value="[positiveInt]"/><!-- I 0..1 Height of the image in pixels (photo/video) --> <width value="[positiveInt]"/><!-- I 0..1 Width of the image in pixels (photo/video) --> <frames value="[positiveInt]"/><!-- I 0..1 Number of frames if > 1 (photo) --> <duration value="[decimal]"/><!-- I 0..1 Length in seconds (audio / video) --> <pages value="[positiveInt]"/><!-- I 0..1 Number of printed pages --> </content> </Library>
{ // ModelInfoLibrary // from Element: extension "meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText 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 // I // from Element: extension }, { // narrative | semi-structured | structured | executable // I // from Element: extension }, { // Additional documentation, review, or usage guidance // I // from Element: extension } ], "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this library, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the library "version" : "<string>", // I R! Business version of the library // value[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", // IHow to compare versions "versionAlgorithmCoding" : { Coding }, // IHow to compare versions "name" : "<string>", // IName for this library (computer friendly) "title" : "<string>", // I R! Name for this library (human friendly) "subtitle" : "<string>", // ISubordinate title of the library "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // IFor testing purposes, not real usage "type" : { CodeableConcept }, // I 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 }, // IType of individual the library content is focused on "subjectReference" : { Reference(Group) }, // IType of individual the library content is focused on "date" : "<dateTime>", // IDate last changed "publisher" : "<string>", // IName of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "description" : "<markdown>", // I R! Natural language description of the library "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for library (if applicable) "purpose" : "<markdown>", // IWhy this library is defined "usage" : "<markdown>", // IDescribes the clinical usage of the library "copyright" : "<markdown>", // IUse and/or publishing restrictions "copyrightLabel" : "<string>", // ICopyright holder and year(s) "approvalDate" : "<date>", // IWhen the library was approved by publisher "lastReviewDate" : "<date>", // IWhen the library was last reviewed by the publisher "effectivePeriod" : { Period }, // IWhen the library is expected to be used "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // IWho authored the content "editor" : [{ ContactDetail }], // IWho edited the content "reviewer" : [{ ContactDetail }], // IWho reviewed the content "endorser" : [{ ContactDetail }], // IWho endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc "parameter" : [{ ParameterDefinition }], // IParameters defined by the library "dataRequirement" : [{ DataRequirement }], // IWhat data is referenced by this library "content" : [ // sliced by value:contentType in the specified order, Open { // ModelInfo XML Content // I // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "contentType" : "application/xml", // I "language" : "<code>", // IHuman language of the content (BCP-47) "data" : "<base64Binary>", // I R! Data inline, base64ed "url" : "<url>", // IUri where the data can be found "size" : "<integer64>", // INumber of bytes of content (if url provided) "hash" : "<base64Binary>", // IHash of the data (sha-1, base64ed) "title" : "<string>", // ILabel to display in place of the data "creation" : "<dateTime>", // IDate attachment was first created "height" : "<positiveInt>", // IHeight of the image in pixels (photo/video) "width" : "<positiveInt>", // IWidth of the image in pixels (photo/video) "frames" : "<positiveInt>", // INumber of frames if > 1 (photo) "duration" : <decimal>, // ILength in seconds (audio / video) "pages" : "<positiveInt>" // INumber of printed pages }, { // ModelInfo JSON Content // I // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "contentType" : "application/json", // I "language" : "<code>", // IHuman language of the content (BCP-47) "data" : "<base64Binary>", // I R! Data inline, base64ed "url" : "<url>", // IUri where the data can be found "size" : "<integer64>", // INumber of bytes of content (if url provided) "hash" : "<base64Binary>", // IHash of the data (sha-1, base64ed) "title" : "<string>", // ILabel to display in place of the data "creation" : "<dateTime>", // IDate attachment was first created "height" : "<positiveInt>", // IHeight of the image in pixels (photo/video) "width" : "<positiveInt>", // IWidth of the image in pixels (photo/video) "frames" : "<positiveInt>", // INumber of frames if > 1 (photo) "duration" : <decimal>, // ILength in seconds (audio / video) "pages" : "<positiveInt>" // INumber of printed pages } ], }
This structure is derived from ShareableLibrary.
Summary
Mandatory: 1 element (+2 nested mandatory elements)
Must-Support: 7 elements
Fixed Value: 2 elements
Slices
This structure defines the following Slices:
Differential View
This indicates the differences between this profile and the base ShareableLibrary structure.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | ShareableLibrary | Represents a library of quality improvement components | |
type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: model-definition | |
Slices for content | S | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType |
content:modelInfoXmlContent | S | 0..* | Attachment | ModelInfo XML Content |
contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/xml |
data | S | 1..1 | base64Binary | Data inline, base64ed |
content:modelInfoJsonContent | S | 0..* | Attachment | ModelInfo JSON Content |
contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/json |
data | S | 1..1 | base64Binary | Data inline, base64ed |
Documentation for this format |
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableLibrary structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Library | C | 1..1 | ShareableLibrary | Represents a library of quality improvement components cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
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 | ||||
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) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
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: model-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] | 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 | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |||||
dataRequirement | 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:modelInfoXmlContent | SΣ | 0..* | Attachment | ModelInfo 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/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:modelInfoJsonContent | SΣ | 0..* | Attachment | ModelInfo 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/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) | |||||
duration | 0..1 | decimal | Length in seconds (audio / video) | |||||
pages | 0..1 | positiveInt | Number of printed pages | |||||
Documentation for this format |
XML Template
<!-- ModelInfoLibrary --> <Library xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the library --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the library --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this library (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this library (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the library --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage --> <type><!-- I 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the library --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this library is defined --> <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the library was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the library was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the library is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <parameter><!-- I 0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!-- I 0..* DataRequirement What data is referenced by this library --></dataRequirement> <-- content sliced by value:contentType in the specified orderOpen--> <content> I 0..* Attachment <!-- I 0..* ModelInfo XML Content --> <contentType value="[code]"/><!-- I 0..1 Mime type of the content, with charset etc. --> <language value="[code]"/><!-- I 0..1 Human language of the content (BCP-47) --> <data value="[base64Binary]"/><!-- I 1..1 Data inline, base64ed --> <url value="[url]"/><!-- I 0..1 Uri where the data can be found --> <size value="[integer64]"/><!-- I 0..1 Number of bytes of content (if url provided) --> <hash value="[base64Binary]"/><!-- I 0..1 Hash of the data (sha-1, base64ed) --> <title value="[string]"/><!-- I 0..1 Label to display in place of the data --> <creation value="[dateTime]"/><!-- I 0..1 Date attachment was first created --> <height value="[positiveInt]"/><!-- I 0..1 Height of the image in pixels (photo/video) --> <width value="[positiveInt]"/><!-- I 0..1 Width of the image in pixels (photo/video) --> <frames value="[positiveInt]"/><!-- I 0..1 Number of frames if > 1 (photo) --> <duration value="[decimal]"/><!-- I 0..1 Length in seconds (audio / video) --> <pages value="[positiveInt]"/><!-- I 0..1 Number of printed pages --> </content> <content> I 0..* Attachment <!-- I 0..* ModelInfo JSON Content --> <contentType value="[code]"/><!-- I 0..1 Mime type of the content, with charset etc. --> <language value="[code]"/><!-- I 0..1 Human language of the content (BCP-47) --> <data value="[base64Binary]"/><!-- I 1..1 Data inline, base64ed --> <url value="[url]"/><!-- I 0..1 Uri where the data can be found --> <size value="[integer64]"/><!-- I 0..1 Number of bytes of content (if url provided) --> <hash value="[base64Binary]"/><!-- I 0..1 Hash of the data (sha-1, base64ed) --> <title value="[string]"/><!-- I 0..1 Label to display in place of the data --> <creation value="[dateTime]"/><!-- I 0..1 Date attachment was first created --> <height value="[positiveInt]"/><!-- I 0..1 Height of the image in pixels (photo/video) --> <width value="[positiveInt]"/><!-- I 0..1 Width of the image in pixels (photo/video) --> <frames value="[positiveInt]"/><!-- I 0..1 Number of frames if > 1 (photo) --> <duration value="[decimal]"/><!-- I 0..1 Length in seconds (audio / video) --> <pages value="[positiveInt]"/><!-- I 0..1 Number of printed pages --> </content> </Library>
JSON Template
{ // ModelInfoLibrary // from Element: extension "meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText 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 // I // from Element: extension }, { // narrative | semi-structured | structured | executable // I // from Element: extension }, { // Additional documentation, review, or usage guidance // I // from Element: extension } ], "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this library, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the library "version" : "<string>", // I R! Business version of the library // value[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", // IHow to compare versions "versionAlgorithmCoding" : { Coding }, // IHow to compare versions "name" : "<string>", // IName for this library (computer friendly) "title" : "<string>", // I R! Name for this library (human friendly) "subtitle" : "<string>", // ISubordinate title of the library "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // IFor testing purposes, not real usage "type" : { CodeableConcept }, // I 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 }, // IType of individual the library content is focused on "subjectReference" : { Reference(Group) }, // IType of individual the library content is focused on "date" : "<dateTime>", // IDate last changed "publisher" : "<string>", // IName of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "description" : "<markdown>", // I R! Natural language description of the library "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for library (if applicable) "purpose" : "<markdown>", // IWhy this library is defined "usage" : "<markdown>", // IDescribes the clinical usage of the library "copyright" : "<markdown>", // IUse and/or publishing restrictions "copyrightLabel" : "<string>", // ICopyright holder and year(s) "approvalDate" : "<date>", // IWhen the library was approved by publisher "lastReviewDate" : "<date>", // IWhen the library was last reviewed by the publisher "effectivePeriod" : { Period }, // IWhen the library is expected to be used "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // IWho authored the content "editor" : [{ ContactDetail }], // IWho edited the content "reviewer" : [{ ContactDetail }], // IWho reviewed the content "endorser" : [{ ContactDetail }], // IWho endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc "parameter" : [{ ParameterDefinition }], // IParameters defined by the library "dataRequirement" : [{ DataRequirement }], // IWhat data is referenced by this library "content" : [ // sliced by value:contentType in the specified order, Open { // ModelInfo XML Content // I // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "contentType" : "application/xml", // I "language" : "<code>", // IHuman language of the content (BCP-47) "data" : "<base64Binary>", // I R! Data inline, base64ed "url" : "<url>", // IUri where the data can be found "size" : "<integer64>", // INumber of bytes of content (if url provided) "hash" : "<base64Binary>", // IHash of the data (sha-1, base64ed) "title" : "<string>", // ILabel to display in place of the data "creation" : "<dateTime>", // IDate attachment was first created "height" : "<positiveInt>", // IHeight of the image in pixels (photo/video) "width" : "<positiveInt>", // IWidth of the image in pixels (photo/video) "frames" : "<positiveInt>", // INumber of frames if > 1 (photo) "duration" : <decimal>, // ILength in seconds (audio / video) "pages" : "<positiveInt>" // INumber of printed pages }, { // ModelInfo JSON Content // I // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "contentType" : "application/json", // I "language" : "<code>", // IHuman language of the content (BCP-47) "data" : "<base64Binary>", // I R! Data inline, base64ed "url" : "<url>", // IUri where the data can be found "size" : "<integer64>", // INumber of bytes of content (if url provided) "hash" : "<base64Binary>", // IHash of the data (sha-1, base64ed) "title" : "<string>", // ILabel to display in place of the data "creation" : "<dateTime>", // IDate attachment was first created "height" : "<positiveInt>", // IHeight of the image in pixels (photo/video) "width" : "<positiveInt>", // IWidth of the image in pixels (photo/video) "frames" : "<positiveInt>", // INumber of frames if > 1 (photo) "duration" : <decimal>, // ILength in seconds (audio / video) "pages" : "<positiveInt>" // INumber of printed pages } ], }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
Library.language | All Languages | required | All Languages |
Library.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
Library.status | PublicationStatus | required | PublicationStatus |
Library.type | Library Type | extensible | Library Type |
Library.subject[x] | Participant Resource Types | extensible | Participant Resource Types |
Library.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
Library.topic | Definition Topic | example | Definition Topic |
Library.content.contentType | Mime Types | required | Mime Types |
Library.content.language | All Languages | required | All Languages |
Library.content.contentType | Mime Types | required | Mime Types |
Library.content.language | All Languages | required | All Languages |