Content Management Infrastructure Implementation Guide
0.1.0 - ballot United States of America flag

Content Management Infrastructure Implementation Guide, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/Content-Management-Infrastructure-IG/ and changes regularly. See the Directory of published versions

Resource Profile: CMI Module Definition Library

Official URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-moduledefinitionlibrary Version: 0.1.0
Active as of 2021-11-27 Computable Name: CMIModuleDefinitionLibrary

The CMI Module Definition Library profile defines the must support elements for a library that communicates the effective data requirements and dependencies of an artifact (or set of artifacts). This is most commonly used as the result of a $data-requirements operation, but could also be persisted statically as a way to persist the calculation of effective data requirements for a specific artifact and input parameters

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CMILibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CMILibraryRepresents a library of quality improvement components
... cmi-directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-directReferenceCode
... cmi-inputParameters S0..1Reference(Parameters)Input Parameter
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-inputParameters
... type S1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Required Pattern: At least the following
.... 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: module-definition
... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
.... cmi-defaultValue S0..1string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, QuantityExtension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-defaultValue
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... cmi-isSelective S0..1booleanspecifies whether a given DataRequirement is "selective"
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-isSelective
.... cmi-valueFilter S0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-valueFilter
.... cmi-fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-fhirQueryPattern
... content 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1CMILibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
... extension:comment S0..*?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]]Extension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment
... cmi-directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-directReferenceCode
... cmi-inputParameters S0..1Reference(Parameters)Input Parameter
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-inputParameters
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣI1..1stringName for this library (computer friendly)
... title SΣ0..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 Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (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: module-definition
..... 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: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*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..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (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
... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... cmi-defaultValue S0..1string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, QuantityExtension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-defaultValue
.... name Σ0..1codeName used to access the parameter value
.... use Σ1..1codein | out
Binding: OperationParameterUse (required): Whether the parameter is input or output.

.... min Σ0..1integerMinimum cardinality
.... max Σ0..1stringMaximum cardinality (a number of *)
.... documentation Σ0..1stringA brief description of the parameter
.... type Σ1..1codeWhat type of value
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

.... profile Σ0..1canonical(StructureDefinition)What profile the value is expected to be
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... cmi-isSelective S0..1booleanspecifies whether a given DataRequirement is "selective"
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-isSelective
.... cmi-valueFilter S0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-valueFilter
.... cmi-fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-fhirQueryPattern
.... type Σ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

.... profile Σ0..*canonical(StructureDefinition)The profile of the required data
.... subject[x] Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... mustSupport Σ0..*stringIndicates specific structure elements that are referenced by the knowledge module
.... codeFilter ΣI0..*ElementWhat codes are expected
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ0..1stringA code-valued attribute to filter on
..... searchParam Σ0..1stringA coded (token) parameter to search on
..... valueSet Σ0..1canonical(ValueSet)Valueset for the filter
..... code Σ0..*CodingWhat code is expected
.... dateFilter ΣI0..*ElementWhat dates/date ranges are expected
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ0..1stringA date-valued attribute to filter on
..... searchParam Σ0..1stringA date valued parameter to search on
..... value[x] Σ0..1The value of the filter, as a Period, DateTime, or Duration value
...... valueDateTimedateTime
...... valuePeriodPeriod
...... valueDurationDuration
.... limit Σ0..1positiveIntNumber of results
.... sort Σ0..*ElementOrder of the results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ1..1stringThe name of the attribute to perform the sort
..... direction Σ1..1codeascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1CMILibraryRepresents a library of quality improvement components
... meta Σ1..1MetaMetadata about the resource
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... extension:comment 0..*?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]]Extension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment
... cmi-directReferenceCode 0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-directReferenceCode
... identifier Σ0..*IdentifierAdditional identifier for the library
... title Σ0..1stringName for this library (human friendly)
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... 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: module-definition
... subject[x] 0..1Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

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


... relatedArtifact 0..*RelatedArtifactDependencies used by the artifact
... parameter 0..*ParameterDefinitionParameters defined by the library
.... cmi-defaultValue 0..1string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, QuantityExtension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-defaultValue
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
.... cmi-isSelective 0..1booleanspecifies whether a given DataRequirement is "selective"
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-isSelective
.... cmi-valueFilter 0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-valueFilter

doco Documentation for this format

Differential View

This structure is derived from CMILibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CMILibraryRepresents a library of quality improvement components
... cmi-directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-directReferenceCode
... cmi-inputParameters S0..1Reference(Parameters)Input Parameter
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-inputParameters
... type S1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Required Pattern: At least the following
.... 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: module-definition
... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
.... cmi-defaultValue S0..1string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, QuantityExtension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-defaultValue
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... cmi-isSelective S0..1booleanspecifies whether a given DataRequirement is "selective"
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-isSelective
.... cmi-valueFilter S0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-valueFilter
.... cmi-fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-fhirQueryPattern
... content 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1CMILibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
... extension:comment S0..*?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]]Extension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment
... cmi-directReferenceCode S0..*CodingA code directly referenced by the measure
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-directReferenceCode
... cmi-inputParameters S0..1Reference(Parameters)Input Parameter
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-inputParameters
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣI1..1stringName for this library (computer friendly)
... title SΣ0..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 Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (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: module-definition
..... 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: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*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..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (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
... relatedArtifact S0..*RelatedArtifactDependencies used by the artifact
... parameter S0..*ParameterDefinitionParameters defined by the library
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... cmi-defaultValue S0..1string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, QuantityExtension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-defaultValue
.... name Σ0..1codeName used to access the parameter value
.... use Σ1..1codein | out
Binding: OperationParameterUse (required): Whether the parameter is input or output.

.... min Σ0..1integerMinimum cardinality
.... max Σ0..1stringMaximum cardinality (a number of *)
.... documentation Σ0..1stringA brief description of the parameter
.... type Σ1..1codeWhat type of value
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

.... profile Σ0..1canonical(StructureDefinition)What profile the value is expected to be
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... cmi-isSelective S0..1booleanspecifies whether a given DataRequirement is "selective"
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-isSelective
.... cmi-valueFilter S0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-valueFilter
.... cmi-fhirQueryPattern 0..*stringWhat FHIR query?
URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-fhirQueryPattern
.... type Σ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

.... profile Σ0..*canonical(StructureDefinition)The profile of the required data
.... subject[x] Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... mustSupport Σ0..*stringIndicates specific structure elements that are referenced by the knowledge module
.... codeFilter ΣI0..*ElementWhat codes are expected
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ0..1stringA code-valued attribute to filter on
..... searchParam Σ0..1stringA coded (token) parameter to search on
..... valueSet Σ0..1canonical(ValueSet)Valueset for the filter
..... code Σ0..*CodingWhat code is expected
.... dateFilter ΣI0..*ElementWhat dates/date ranges are expected
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ0..1stringA date-valued attribute to filter on
..... searchParam Σ0..1stringA date valued parameter to search on
..... value[x] Σ0..1The value of the filter, as a Period, DateTime, or Duration value
...... valueDateTimedateTime
...... valuePeriodPeriod
...... valueDurationDuration
.... limit Σ0..1positiveIntNumber of results
.... sort Σ0..*ElementOrder of the results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... path Σ1..1stringThe name of the attribute to perform the sort
..... direction Σ1..1codeascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Library.meta.securityextensibleAll Security Labels
Library.meta.tagexampleCommonTags
Library.languagepreferredCommonLanguages
Max Binding: AllLanguages
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: module-definition
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensible​Jurisdiction ValueSet (missing link)
Library.topicexample​DefinitionTopic (missing link)
Library.parameter.userequiredOperationParameterUse
Library.parameter.typerequiredFHIRAllTypes
Library.dataRequirement.typerequiredFHIRAllTypes
Library.dataRequirement.subject[x]extensibleSubjectType
Library.dataRequirement.sort.directionrequiredSortDirection

Constraints

IdGradePathDetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLibraryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeLibraryA resource should have narrative for robust management
: text.`div`.exists()
lib-0warningLibraryName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ele-1errorLibrary.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.meta.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.meta.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.meta.versionIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.meta.lastUpdatedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.meta.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.meta.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.meta.securityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.meta.tagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.extension:commentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.extension:commentMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.extension:directReferenceCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.extension:directReferenceCodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.extension:inputParametersAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.extension:inputParametersMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.subtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.usageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.approvalDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.lastReviewDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.effectivePeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.editorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.reviewerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.endorserAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.parameter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.parameter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.parameter.extension:defaultValueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.parameter.extension:defaultValueMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.parameter.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.parameter.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.parameter.minAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.parameter.maxAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.parameter.documentationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.parameter.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.parameter.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.dataRequirement.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.dataRequirement.extension:isSelectiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.dataRequirement.extension:isSelectiveMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.dataRequirement.extension:valueFilterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.dataRequirement.extension:valueFilterMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.dataRequirement.extension:fhirQueryPatternAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.dataRequirement.extension:fhirQueryPatternMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.dataRequirement.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.mustSupportAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
drq-1errorLibrary.dataRequirement.codeFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
ele-1errorLibrary.dataRequirement.codeFilterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.codeFilter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.dataRequirement.codeFilter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.dataRequirement.codeFilter.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.codeFilter.searchParamAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.codeFilter.valueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.codeFilter.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
drq-2errorLibrary.dataRequirement.dateFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
ele-1errorLibrary.dataRequirement.dateFilterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.dateFilter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.dataRequirement.dateFilter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.dataRequirement.dateFilter.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.dateFilter.searchParamAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.dateFilter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.limitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.sortAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.sort.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.dataRequirement.sort.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.dataRequirement.sort.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirement.sort.directionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())