This 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/moduledefinitionlibrary
The module definition library profile sets the expectations for module definition libraries, including support for terminology and dependency declaration, parameters, and data requirements
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 ShareableLibrary.
Summary
Mandatory: 1 element (+1 nested mandatory element)
Must-Support: 10 elements
Fixed Value: 1 element
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from ShareableLibrary.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | ShareableLibrary | Represents a library of quality improvement components | |
cqf-inputParameters | S | 0..1 | Reference(Parameters) | What parameters URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
cqf-directReferenceCode | S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode |
cqf-logicDefinition | S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
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: logic-library | |
subject[x] | S | 0..1 | CodeableConcept, Reference(Group) | Type of individual the library content is focused on |
relatedArtifact | S | 0..* | (Slice Definition) | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
relatedArtifact:dependency | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on |
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 | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | ShareableLibrary | 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-inputParameters | S | 0..1 | Reference(Parameters) | What parameters URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
cqf-directReferenceCode | S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode |
cqf-logicDefinition | S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
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: logic-library | |
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 |
Documentation for this format |
<!-- ModuleDefinitionLibrary --> <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]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- 1..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the library --></identifier> <version value="[string]"/><!-- 1..1 Business version of the library --> <name value="[string]"/><!-- 1..1 Name for this library (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this library (human friendly) --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the library --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 1..1 For testing purposes, not real usage --> <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 1..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 1..1 Natural language description of the library --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this library is defined --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the library was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the library was last reviewed --> <effectivePeriod><!-- 0..1 Period When the library is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic> <author><!-- 0..* ContactDetail Who authored the content --></author> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <-- relatedArtifact sliced by value:type in the specified orderOpen--> <relatedArtifact> 0..* RelatedArtifact <!-- 0..* Additional documentation, citations, etc. --> <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of --> <label value="[string]"/><!-- 0..1 Short label --> <display value="[string]"/><!-- 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact --> <url value="[url]"/><!-- 0..1 Where the artifact can be accessed --> <document><!-- 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- 1..1 What resource is being referenced --> </relatedArtifact> <parameter><!-- 0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!-- 0..* DataRequirement What data is referenced by this library --></dataRequirement> <content><!-- 0..0 Attachment Contents of the library, either embedded or referenced --></content> </Library>
{ // ModuleDefinitionLibrary // 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 }, { // What parameters // C? // from Element: extension }, { // A code directly referenced by the artifact // C? // from Element: extension }, { // A logic definition used in 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 }
This structure is derived from ShareableLibrary.
Summary
Mandatory: 1 element (+1 nested mandatory element)
Must-Support: 10 elements
Fixed Value: 1 element
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ShareableLibrary.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | ShareableLibrary | Represents a library of quality improvement components | |
cqf-inputParameters | S | 0..1 | Reference(Parameters) | What parameters URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
cqf-directReferenceCode | S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode |
cqf-logicDefinition | S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
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: logic-library | |
subject[x] | S | 0..1 | CodeableConcept, Reference(Group) | Type of individual the library content is focused on |
relatedArtifact | S | 0..* | (Slice Definition) | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
relatedArtifact:dependency | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on |
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 | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | ShareableLibrary | 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-inputParameters | S | 0..1 | Reference(Parameters) | What parameters URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
cqf-directReferenceCode | S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode |
cqf-logicDefinition | S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
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: logic-library | |
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 |
Documentation for this format |
XML Template
<!-- ModuleDefinitionLibrary --> <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]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- 1..1 Canonical identifier for this library, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the library --></identifier> <version value="[string]"/><!-- 1..1 Business version of the library --> <name value="[string]"/><!-- 1..1 Name for this library (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this library (human friendly) --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the library --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 1..1 For testing purposes, not real usage --> <type><!-- 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition --></type> <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on --></subject[x]> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 1..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 1..1 Natural language description of the library --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for library (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this library is defined --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the library --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the library was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the library was last reviewed --> <effectivePeriod><!-- 0..1 Period When the library is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic> <author><!-- 0..* ContactDetail Who authored the content --></author> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <-- relatedArtifact sliced by value:type in the specified orderOpen--> <relatedArtifact> 0..* RelatedArtifact <!-- 0..* Additional documentation, citations, etc. --> <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of --> <label value="[string]"/><!-- 0..1 Short label --> <display value="[string]"/><!-- 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact --> <url value="[url]"/><!-- 0..1 Where the artifact can be accessed --> <document><!-- 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- 1..1 What resource is being referenced --> </relatedArtifact> <parameter><!-- 0..* ParameterDefinition Parameters defined by the library --></parameter> <dataRequirement><!-- 0..* DataRequirement What data is referenced by this library --></dataRequirement> <content><!-- 0..0 Attachment Contents of the library, either embedded or referenced --></content> </Library>
JSON Template
{ // ModuleDefinitionLibrary // 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 }, { // What parameters // C? // from Element: extension }, { // A code directly referenced by the artifact // C? // from Element: extension }, { // A logic definition used in 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 }
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 |