Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

Clinical Decision Support icon Work Group Maturity Level: 0Trial Use Use Context: Country: World

The canonical 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:

  • The element Library.relatedArtifact is sliced based on the value of value:type

This indicates the differences between this profile and the base ShareableLibrary structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1ShareableLibraryRepresents a library of quality improvement components
... inputParameters S0..1Reference(Parameters)What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
... directReferenceCode S0..*CodingA code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logic-library
... subject[x] S0..1CodeableConcept, Reference(Group)Type of individual the library content is focused on
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S0..*RelatedArtifactAdditional documentation, citations, etc
..... type S1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Fixed Value: depends-on
..... resource S1..1canonical(CodeSystem | ValueSet | Library)What artifact is being referenced
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content 0..0

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableLibrary structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C icon1..1ShareableLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: All Languages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... inputParameters S0..1Reference(Parameters)What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
... directReferenceCode S0..*CodingA code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... versionAlgorithm[x] SΣ0..1How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC icon0..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logic-library
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject[x] S0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the library
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... usage 0..1markdownDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S0..*RelatedArtifactAdditional documentation, citations, etc
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: depends-on
..... classifier Σ0..*CodeableConceptAdditional classifiers
Binding: Citation Artifact Classifier (example): Additional classifiers for the related artifact.


..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(CodeSystem | ValueSet | Library)What artifact is being referenced
..... resourceReference Σ0..1Reference(Resource)What artifact, if not a conformance resource
..... publicationStatus Σ0..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.

..... publicationDate Σ0..1dateDate of publication of the artifact being referred to
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library

doco Documentation for this format icon
<!-- ModuleDefinitionLibrary -->doco

<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 sliced by value:type  in the specified orderOpen-->
 <relatedArtifact> I 0..* RelatedArtifact  <!-- I 0..* Additional documentation, citations, etc -->
  <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as   -->
  <classifier><!-- I 0..* CodeableConcept Additional classifiers   --></classifier>
  <label value="[string]"/><!-- I 0..1 Short label -->
  <display value="[string]"/><!-- I 0..1 Brief description of the related artifact -->
  <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact -->
  <document><!-- I 0..1 Attachment 
      What document is being referenced --></document>
  <resource value="[canonical]"/><!-- I 1..1 What artifact is being referenced -->
  <resourceReference><!-- I 0..1 Reference(Resource) 
      What artifact, if not a conformance resource --></resourceReference>
  <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown   -->
  <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to -->
 </relatedArtifact>
 <parameter><!-- I 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- I 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content><!-- I 0..0 Attachment 
     Contents of the library, either embedded or referenced --></content>
</Library>
{ // ModuleDefinitionLibrary
  // 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
      },
      { // What parameters // I
        // from Element: extension
      },
      { // A code directly referenced by the artifact // I
        // from Element: extension
      },
      { // A logic definition used in the artifact // 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" : [ //  sliced by value:type  in the specified order, Open 
      { // Additional documentation, citations, etc // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "type" : "depends-on", // I R! 
        "classifier" : [{ CodeableConcept }], // IAdditional classifiers
        "label" : "<string>", // IShort label
        "display" : "<string>", // IBrief description of the related artifact
        "citation" : "<markdown>", // IBibliographic citation for the artifact
        "document" : { Attachment }, // IWhat document is being referenced
        "resource" : "<canonical>", // I R! What artifact is being referenced
        "resourceReference" : { Reference(Resource) }, // IWhat artifact, if not a conformance resource
        "publicationStatus" : "<code>", // Idraft | active | retired | unknown
        "publicationDate" : "<date>" // IDate of publication of the artifact being referred to
      }
    ],
    "parameter" : [{ ParameterDefinition }], // IParameters defined by the library
    "dataRequirement" : [{ DataRequirement }], // IWhat 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:

  • The element Library.relatedArtifact is sliced based on the value of value:type

Differential View

This indicates the differences between this profile and the base ShareableLibrary structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1ShareableLibraryRepresents a library of quality improvement components
... inputParameters S0..1Reference(Parameters)What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
... directReferenceCode S0..*CodingA code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logic-library
... subject[x] S0..1CodeableConcept, Reference(Group)Type of individual the library content is focused on
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S0..*RelatedArtifactAdditional documentation, citations, etc
..... type S1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Fixed Value: depends-on
..... resource S1..1canonical(CodeSystem | ValueSet | Library)What artifact is being referenced
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content 0..0

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableLibrary structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C icon1..1ShareableLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: All Languages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... inputParameters S0..1Reference(Parameters)What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
... directReferenceCode S0..*CodingA code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... versionAlgorithm[x] SΣ0..1How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC icon0..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logic-library
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject[x] S0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the library
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... usage 0..1markdownDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S0..*RelatedArtifactAdditional documentation, citations, etc
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: depends-on
..... classifier Σ0..*CodeableConceptAdditional classifiers
Binding: Citation Artifact Classifier (example): Additional classifiers for the related artifact.


..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(CodeSystem | ValueSet | Library)What artifact is being referenced
..... resourceReference Σ0..1Reference(Resource)What artifact, if not a conformance resource
..... publicationStatus Σ0..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.

..... publicationDate Σ0..1dateDate of publication of the artifact being referred to
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library

doco Documentation for this format icon

XML Template

<!-- ModuleDefinitionLibrary -->doco

<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 sliced by value:type  in the specified orderOpen-->
 <relatedArtifact> I 0..* RelatedArtifact  <!-- I 0..* Additional documentation, citations, etc -->
  <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as   -->
  <classifier><!-- I 0..* CodeableConcept Additional classifiers   --></classifier>
  <label value="[string]"/><!-- I 0..1 Short label -->
  <display value="[string]"/><!-- I 0..1 Brief description of the related artifact -->
  <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact -->
  <document><!-- I 0..1 Attachment 
      What document is being referenced --></document>
  <resource value="[canonical]"/><!-- I 1..1 What artifact is being referenced -->
  <resourceReference><!-- I 0..1 Reference(Resource) 
      What artifact, if not a conformance resource --></resourceReference>
  <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown   -->
  <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to -->
 </relatedArtifact>
 <parameter><!-- I 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- I 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content><!-- I 0..0 Attachment 
     Contents of the library, either embedded or referenced --></content>
</Library>

JSON Template

{ // ModuleDefinitionLibrary
  // 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
      },
      { // What parameters // I
        // from Element: extension
      },
      { // A code directly referenced by the artifact // I
        // from Element: extension
      },
      { // A logic definition used in the artifact // 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" : [ //  sliced by value:type  in the specified order, Open 
      { // Additional documentation, citations, etc // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "type" : "depends-on", // I R! 
        "classifier" : [{ CodeableConcept }], // IAdditional classifiers
        "label" : "<string>", // IShort label
        "display" : "<string>", // IBrief description of the related artifact
        "citation" : "<markdown>", // IBibliographic citation for the artifact
        "document" : { Attachment }, // IWhat document is being referenced
        "resource" : "<canonical>", // I R! What artifact is being referenced
        "resourceReference" : { Reference(Resource) }, // IWhat artifact, if not a conformance resource
        "publicationStatus" : "<code>", // Idraft | active | retired | unknown
        "publicationDate" : "<date>" // IDate of publication of the artifact being referred to
      }
    ],
    "parameter" : [{ ParameterDefinition }], // IParameters defined by the library
    "dataRequirement" : [{ DataRequirement }], // IWhat data is referenced by this library
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

PathNameConformanceValueSet
Library.languageAll LanguagesrequiredAll Languages
Library.versionAlgorithm[x]Version AlgorithmextensibleVersion Algorithm
Library.statusPublicationStatusrequiredPublicationStatus
Library.typeLibrary TypeextensibleLibrary Type
Library.subject[x]Participant Resource TypesextensibleParticipant Resource Types
Library.jurisdictionJurisdiction ValueSetextensibleJurisdiction ValueSet
Library.topicDefinition TopicexampleDefinition Topic
Library.relatedArtifact.typeRelatedArtifactTyperequiredRelatedArtifactType
Library.relatedArtifact.classifierCitation Artifact ClassifierexampleCitation Artifact Classifier
Library.relatedArtifact.publicationStatusPublicationStatusrequiredPublicationStatus
. .