{
"description": "The CQFM Library profile defines expectations for a library used to distribute eCQM logic",
"_filename": "StructureDefinition-library-cqfm.json",
"package_name": "hl7.fhir.us.cqfmeasures",
"date": "2019-02-13T00:00:00-05:00",
"derivation": "constraint",
"publisher": "Health Level Seven, Inc. - CQI WG",
"fhirVersion": "3.0.2",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America"
} ]
} ],
"name": "CQFMLibrary",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information",
"identity": "objimpl"
} ],
"abstract": false,
"type": "Library",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "Library",
"min": 0,
"definition": "The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.",
"short": "Represents a library of quality improvement components",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Act[classCode=GROUPER;moodCode=EVN]",
"identity": "rim"
}, {
"map": "clinical.general",
"identity": "w5"
} ],
"mustSupport": false,
"max": "*",
"id": "Library",
"base": {
"max": "*",
"min": 0,
"path": "Library"
}
}, {
"path": "Library.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Library.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Library.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Library.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Library.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Library.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Library.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Library.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Library.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Library.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Library.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Library.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Library.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Library.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Library.extension",
"min": 0,
"definition": "A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.",
"short": "Additional documentation, review, or usage guidance",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment"
} ],
"mustSupport": true,
"sliceName": "comment",
"max": "*",
"id": "Library.extension:comment",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Library.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Library.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Library.url",
"requirements": "A published library must have a canonical url defined.",
"min": 1,
"definition": "An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](http://hl7.org/fhir/STU3/resource.html#versions).",
"short": "Logical URI to reference this library (globally unique)",
"mapping": [ {
"map": ".identifier[scope=BUSN;reliability=ISS]",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.url",
"comment": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.",
"base": {
"max": "1",
"min": 0,
"path": "Library.url"
},
"isSummary": true
}, {
"path": "Library.identifier",
"requirements": "A published library must have at least one identifier defined.",
"min": 1,
"definition": "A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.",
"short": "Additional identifier for the library",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Library.identifier",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this library outside of FHIR, where it is not possible to use the logical URI.",
"base": {
"max": "*",
"min": 0,
"path": "Library.identifier"
},
"isSummary": true
}, {
"path": "Library.version",
"requirements": "A published library must specify a content version.",
"min": 1,
"definition": "The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"short": "Business version of the library",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
}, {
"map": "id.version",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.version",
"comment": "There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the library with the format [url]|[version].",
"base": {
"max": "1",
"min": 0,
"path": "Library.version"
},
"isSummary": true
}, {
"path": "Library.name",
"requirements": "A published library must specify a valid, machine-friendly name.",
"min": 1,
"definition": "A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"short": "Name for this library (computer friendly)",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.name",
"comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.",
"base": {
"max": "1",
"min": 0,
"path": "Library.name"
},
"isSummary": true
}, {
"path": "Library.title",
"requirements": "A published library must specify a human-friendly title.",
"min": 1,
"definition": "A short, descriptive, user-friendly title for the library.",
"short": "Name for this library (human friendly)",
"mapping": [ {
"map": ".title",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Library.title"
},
"isSummary": true
}, {
"path": "Library.status",
"min": 1,
"definition": "The status of this library. Enables tracking the life-cycle of the content.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": ".status",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"max": "1",
"id": "Library.status",
"comment": "Allows filtering of librarys that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired library without due consideration.",
"base": {
"max": "1",
"min": 1,
"path": "Library.status"
},
"isSummary": true
}, {
"path": "Library.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level library.",
"min": 0,
"definition": "A boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"isModifier": true,
"short": "For testing purposes, not real usage",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Library.experimental",
"comment": "Allows filtering of library that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental library in production.",
"base": {
"max": "1",
"min": 0,
"path": "Library.experimental"
},
"isSummary": true
}, {
"path": "Library.type",
"min": 1,
"definition": "Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.",
"short": "logic-library | model-definition | asset-collection | module-definition",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "LibraryType"
} ],
"description": "The type of knowledge asset this library contains",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/library-type"
}
},
"max": "1",
"id": "Library.type",
"base": {
"max": "1",
"min": 1,
"path": "Library.type"
},
"isSummary": true
}, {
"path": "Library.date",
"requirements": "A published library must specify the date the library content was last changed.",
"min": 1,
"definition": "The date (and optionally time) when the library was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.",
"short": "Date this was last changed",
"mapping": [ {
"map": ".participation[typeCode=AUT].time",
"identity": "rim"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": true,
"alias": [ "Revision Date" ],
"max": "1",
"id": "Library.date",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"base": {
"max": "1",
"min": 0,
"path": "Library.date"
},
"isSummary": true
}, {
"path": "Library.publisher",
"requirements": "A published library must provide publisher information.",
"min": 1,
"definition": "The name of the individual or organization that published the library.",
"short": "Name of the publisher (organization or individual)",
"mapping": [ {
"map": ".participation[typeCode=AUT].role",
"identity": "rim"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.publisher",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.",
"base": {
"max": "1",
"min": 0,
"path": "Library.publisher"
},
"isSummary": true
}, {
"path": "Library.description",
"requirements": "A published library must provide a concise description of the library content.",
"min": 1,
"definition": "A free text natural language description of the library from a consumer's perspective.",
"short": "Natural language description of the library",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.description",
"comment": "This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).",
"base": {
"max": "1",
"min": 0,
"path": "Library.description"
},
"isSummary": true
}, {
"path": "Library.purpose",
"requirements": "A published library should provide a clear description of the purpose of the library.",
"min": 0,
"definition": "Explaination of why this library is needed and why it has been designed as it has.",
"short": "Why this library is defined",
"mapping": [ {
"map": ".reasonCode.text",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.purpose",
"comment": "This element does not describe the usage of the library Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.",
"base": {
"max": "1",
"min": 0,
"path": "Library.purpose"
}
}, {
"path": "Library.usage",
"requirements": "A published library should provide clinical usage notes for the library.",
"min": 0,
"definition": "A detailed description of how the library is used from a clinical perspective.",
"short": "Describes the clinical usage of the library",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.usage",
"base": {
"max": "1",
"min": 0,
"path": "Library.usage"
}
}, {
"path": "Library.approvalDate",
"requirements": "A published library must indicate the date the library content was approved by the publisher.",
"min": 1,
"definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"short": "When the library was approved by publisher",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.approvalDate",
"comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.",
"base": {
"max": "1",
"min": 0,
"path": "Library.approvalDate"
}
}, {
"path": "Library.lastReviewDate",
"requirements": "A published library must indicate when the library content was last reviewed.",
"min": 1,
"definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.",
"short": "When the library was last reviewed",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.lastReviewDate",
"comment": "If specified, this is usually after the approval date.",
"base": {
"max": "1",
"min": 0,
"path": "Library.lastReviewDate"
}
}, {
"path": "Library.effectivePeriod",
"requirements": "A published library should provide an indication of the period during which the library content can be effectively applied.",
"min": 0,
"definition": "The period during which the library content was or is planned to be in active use.",
"short": "When the library is expected to be used",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": true,
"max": "1",
"id": "Library.effectivePeriod",
"comment": "The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"base": {
"max": "1",
"min": 0,
"path": "Library.effectivePeriod"
},
"isSummary": true
}, {
"path": "Library.useContext",
"requirements": "A published library should provide a clear indication of the expected contexts of use for the library content.",
"min": 0,
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate library instances.",
"short": "Context the content is intended to support",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "UsageContext"
} ],
"mustSupport": true,
"max": "*",
"id": "Library.useContext",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"base": {
"max": "*",
"min": 0,
"path": "Library.useContext"
},
"isSummary": true
}, {
"path": "Library.jurisdiction",
"requirements": "A published library should indicate intended jurisdictions for the library content.",
"min": 0,
"definition": "A legal or geographic region in which the library is intended to be used.",
"short": "Intended jurisdiction for library (if applicable)",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
"max": "*",
"id": "Library.jurisdiction",
"comment": "It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.",
"base": {
"max": "*",
"min": 0,
"path": "Library.jurisdiction"
},
"isSummary": true
}, {
"path": "Library.topic",
"requirements": "A published library should provide relevant topics for the library content.",
"min": 0,
"definition": "Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.",
"short": "E.g. Education, Treatment, Assessment, etc",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DefinitionTopic"
} ],
"description": "High-level categorization of the definition, used for searching, sorting, and filtering",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/definition-topic"
}
},
"max": "*",
"id": "Library.topic",
"base": {
"max": "*",
"min": 0,
"path": "Library.topic"
}
}, {
"path": "Library.contributor",
"requirements": "A published library should provide information on contributors to the library content.",
"min": 0,
"definition": "A contributor to the content of the library, including authors, editors, reviewers, and endorsers.",
"short": "A content contributor",
"mapping": [ {
"map": ".participation[typeCode=AUT,VRF] {No support yet for editor nor clear whether VRF best corresponds to reviewer or endorser}",
"identity": "rim"
} ],
"type": [ {
"code": "Contributor"
} ],
"mustSupport": true,
"max": "*",
"id": "Library.contributor",
"base": {
"max": "*",
"min": 0,
"path": "Library.contributor"
}
}, {
"path": "Library.contact",
"requirements": "A published library must provide contact information for the publisher.",
"min": 1,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"short": "Contact details for the publisher",
"mapping": [ {
"map": ".participation[typeCode=CALLBCK].role",
"identity": "rim"
} ],
"type": [ {
"code": "ContactDetail"
} ],
"mustSupport": true,
"max": "*",
"id": "Library.contact",
"comment": "May be a web site, an email address, a telephone number, etc.",
"base": {
"max": "*",
"min": 0,
"path": "Library.contact"
},
"isSummary": true
}, {
"path": "Library.copyright",
"requirements": "A published library should provide copyright information for the library content.",
"min": 0,
"definition": "A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.",
"short": "Use and/or publishing restrictions",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": true,
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "Library.copyright",
"base": {
"max": "1",
"min": 0,
"path": "Library.copyright"
}
}, {
"path": "Library.relatedArtifact",
"requirements": "A published library should provide related information such as supporting evidence, citations, and documentation.",
"min": 0,
"definition": "Any referenced CQL libraries or additional documentation, citations, etc.",
"short": "Any referenced CQL libraries or additional documentation, citations, etc.",
"mapping": [ {
"map": ".outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}",
"identity": "rim"
} ],
"type": [ {
"code": "RelatedArtifact"
} ],
"mustSupport": true,
"max": "*",
"id": "Library.relatedArtifact",
"comment": "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"base": {
"max": "*",
"min": 0,
"path": "Library.relatedArtifact"
}
}, {
"path": "Library.parameter",
"requirements": "A published library should provide a description of any parameters defined by the library.",
"min": 0,
"definition": "The parameter element defines parameters used by the library.",
"short": "Parameters defined by the library",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "ParameterDefinition"
} ],
"mustSupport": true,
"max": "*",
"id": "Library.parameter",
"base": {
"max": "*",
"min": 0,
"path": "Library.parameter"
}
}, {
"path": "Library.dataRequirement",
"requirements": "A published library should provide a description of the data requirements for logic contained in the library.",
"min": 0,
"definition": "Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.",
"short": "What data is referenced by this library",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "DataRequirement"
} ],
"mustSupport": true,
"max": "*",
"id": "Library.dataRequirement",
"base": {
"max": "*",
"min": 0,
"path": "Library.dataRequirement"
}
}, {
"path": "Library.content",
"min": 0,
"definition": "The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.",
"short": "Contents of the library, either embedded or referenced",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "contentType",
"type": "value"
} ]
},
"type": [ {
"code": "Attachment"
} ],
"mustSupport": false,
"max": "*",
"id": "Library.content",
"base": {
"max": "*",
"min": 0,
"path": "Library.content"
}
}, {
"path": "Library.content",
"requirements": "A published library must provide the contents of the library in at least one media format.",
"min": 1,
"definition": "The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.",
"short": "Contents of the library, either embedded or referenced",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": true,
"sliceName": "cqlContent",
"max": "*",
"id": "Library.content:cqlContent",
"base": {
"max": "*",
"min": 0,
"path": "Library.content"
}
}, {
"path": "Library.content.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Library.content:cqlContent.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Library.content.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Library.content:cqlContent.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Library.content.contentType",
"fixedCode": "text/cql",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 1,
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"short": "Mime type of the content, with charset etc.",
"mapping": [ {
"map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used",
"identity": "v2"
}, {
"map": "./mediaType, ./charset",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"max": "1",
"id": "Library.content:cqlContent.contentType",
"example": [ {
"label": "General",
"valueCode": "text/plain; charset=UTF-8, image/png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.contentType"
},
"isSummary": true
}, {
"path": "Library.content.language",
"requirements": "Users need to be able to choose between the languages in a set of attachments.",
"min": 0,
"definition": "The human language of the content. The value can be any valid value according to BCP 47.",
"short": "Human language of the content (BCP-47)",
"mapping": [ {
"map": "./language",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Library.content:cqlContent.language",
"example": [ {
"label": "General",
"valueCode": "en-AU"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.language"
},
"isSummary": true
}, {
"path": "Library.content.data",
"requirements": "The data needs to able to be transmitted inline.",
"min": 0,
"definition": "The actual data of the attachment - a sequence of bytes. In XML, represented using base64.",
"short": "Data inline, base64ed",
"mapping": [ {
"map": "ED.5",
"identity": "v2"
}, {
"map": "./data",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "Library.content:cqlContent.data",
"comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.data"
}
}, {
"path": "Library.content.url",
"requirements": "The data needs to be transmitted by reference.",
"min": 0,
"definition": "An alternative location where the data can be accessed.",
"short": "Uri where the data can be found",
"mapping": [ {
"map": "RP.1+RP.2 - if they refer to a URL (see v2.6)",
"identity": "v2"
}, {
"map": "./reference/literal",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Library.content:cqlContent.url",
"comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/logo-small.png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.url"
},
"isSummary": true
}, {
"path": "Library.content.size",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min": 0,
"definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"short": "Number of bytes of content (if url provided)",
"mapping": [ {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"max": "1",
"id": "Library.content:cqlContent.size",
"comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.size"
},
"isSummary": true
}, {
"path": "Library.content.hash",
"requirements": "Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.",
"min": 0,
"definition": "The calculated hash of the data using SHA-1. Represented using base64.",
"short": "Hash of the data (sha-1, base64ed)",
"mapping": [ {
"map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "Library.content:cqlContent.hash",
"comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.hash"
},
"isSummary": true
}, {
"path": "Library.content.title",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min": 0,
"definition": "A label or set of text to display in place of the data.",
"short": "Label to display in place of the data",
"mapping": [ {
"map": "./title/data",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Library.content:cqlContent.title",
"example": [ {
"label": "General",
"valueString": "Official Corporate Logo"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.title"
},
"isSummary": true
}, {
"path": "Library.content.creation",
"requirements": "This is often tracked as an integrity issue for use of the attachment.",
"min": 0,
"definition": "The date that the attachment was first created.",
"short": "Date attachment was first created",
"mapping": [ {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Library.content:cqlContent.creation",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.creation"
},
"isSummary": true
}, {
"path": "Library.content",
"requirements": "A published library must provide the contents of the library in at least one media format.",
"min": 0,
"definition": "The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.",
"short": "Contents of the library, either embedded or referenced",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": true,
"sliceName": "elmXmlContent",
"max": "*",
"id": "Library.content:elmXmlContent",
"base": {
"max": "*",
"min": 0,
"path": "Library.content"
}
}, {
"path": "Library.content.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Library.content:elmXmlContent.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Library.content.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Library.content:elmXmlContent.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Library.content.contentType",
"fixedCode": "application/elm+xml",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 1,
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"short": "Mime type of the content, with charset etc.",
"mapping": [ {
"map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used",
"identity": "v2"
}, {
"map": "./mediaType, ./charset",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"max": "1",
"id": "Library.content:elmXmlContent.contentType",
"example": [ {
"label": "General",
"valueCode": "text/plain; charset=UTF-8, image/png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.contentType"
},
"isSummary": true
}, {
"path": "Library.content.language",
"requirements": "Users need to be able to choose between the languages in a set of attachments.",
"min": 0,
"definition": "The human language of the content. The value can be any valid value according to BCP 47.",
"short": "Human language of the content (BCP-47)",
"mapping": [ {
"map": "./language",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Library.content:elmXmlContent.language",
"example": [ {
"label": "General",
"valueCode": "en-AU"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.language"
},
"isSummary": true
}, {
"path": "Library.content.data",
"requirements": "The data needs to able to be transmitted inline.",
"min": 0,
"definition": "The actual data of the attachment - a sequence of bytes. In XML, represented using base64.",
"short": "Data inline, base64ed",
"mapping": [ {
"map": "ED.5",
"identity": "v2"
}, {
"map": "./data",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "Library.content:elmXmlContent.data",
"comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.data"
}
}, {
"path": "Library.content.url",
"requirements": "The data needs to be transmitted by reference.",
"min": 0,
"definition": "An alternative location where the data can be accessed.",
"short": "Uri where the data can be found",
"mapping": [ {
"map": "RP.1+RP.2 - if they refer to a URL (see v2.6)",
"identity": "v2"
}, {
"map": "./reference/literal",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Library.content:elmXmlContent.url",
"comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/logo-small.png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.url"
},
"isSummary": true
}, {
"path": "Library.content.size",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min": 0,
"definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"short": "Number of bytes of content (if url provided)",
"mapping": [ {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"max": "1",
"id": "Library.content:elmXmlContent.size",
"comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.size"
},
"isSummary": true
}, {
"path": "Library.content.hash",
"requirements": "Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.",
"min": 0,
"definition": "The calculated hash of the data using SHA-1. Represented using base64.",
"short": "Hash of the data (sha-1, base64ed)",
"mapping": [ {
"map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "Library.content:elmXmlContent.hash",
"comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.hash"
},
"isSummary": true
}, {
"path": "Library.content.title",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min": 0,
"definition": "A label or set of text to display in place of the data.",
"short": "Label to display in place of the data",
"mapping": [ {
"map": "./title/data",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Library.content:elmXmlContent.title",
"example": [ {
"label": "General",
"valueString": "Official Corporate Logo"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.title"
},
"isSummary": true
}, {
"path": "Library.content.creation",
"requirements": "This is often tracked as an integrity issue for use of the attachment.",
"min": 0,
"definition": "The date that the attachment was first created.",
"short": "Date attachment was first created",
"mapping": [ {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Library.content:elmXmlContent.creation",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.creation"
},
"isSummary": true
}, {
"path": "Library.content",
"requirements": "A published library must provide the contents of the library in at least one media format.",
"min": 0,
"definition": "The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.",
"short": "Contents of the library, either embedded or referenced",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": true,
"sliceName": "elmJsonContent",
"max": "*",
"id": "Library.content:elmJsonContent",
"base": {
"max": "*",
"min": 0,
"path": "Library.content"
}
}, {
"path": "Library.content.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Library.content:elmJsonContent.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Library.content.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Library.content:elmJsonContent.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Library.content.contentType",
"fixedCode": "application/elm+json",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 1,
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"short": "Mime type of the content, with charset etc.",
"mapping": [ {
"map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used",
"identity": "v2"
}, {
"map": "./mediaType, ./charset",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"max": "1",
"id": "Library.content:elmJsonContent.contentType",
"example": [ {
"label": "General",
"valueCode": "text/plain; charset=UTF-8, image/png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.contentType"
},
"isSummary": true
}, {
"path": "Library.content.language",
"requirements": "Users need to be able to choose between the languages in a set of attachments.",
"min": 0,
"definition": "The human language of the content. The value can be any valid value according to BCP 47.",
"short": "Human language of the content (BCP-47)",
"mapping": [ {
"map": "./language",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Library.content:elmJsonContent.language",
"example": [ {
"label": "General",
"valueCode": "en-AU"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.language"
},
"isSummary": true
}, {
"path": "Library.content.data",
"requirements": "The data needs to able to be transmitted inline.",
"min": 0,
"definition": "The actual data of the attachment - a sequence of bytes. In XML, represented using base64.",
"short": "Data inline, base64ed",
"mapping": [ {
"map": "ED.5",
"identity": "v2"
}, {
"map": "./data",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "Library.content:elmJsonContent.data",
"comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.data"
}
}, {
"path": "Library.content.url",
"requirements": "The data needs to be transmitted by reference.",
"min": 0,
"definition": "An alternative location where the data can be accessed.",
"short": "Uri where the data can be found",
"mapping": [ {
"map": "RP.1+RP.2 - if they refer to a URL (see v2.6)",
"identity": "v2"
}, {
"map": "./reference/literal",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Library.content:elmJsonContent.url",
"comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/logo-small.png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.url"
},
"isSummary": true
}, {
"path": "Library.content.size",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min": 0,
"definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"short": "Number of bytes of content (if url provided)",
"mapping": [ {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"max": "1",
"id": "Library.content:elmJsonContent.size",
"comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.size"
},
"isSummary": true
}, {
"path": "Library.content.hash",
"requirements": "Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.",
"min": 0,
"definition": "The calculated hash of the data using SHA-1. Represented using base64.",
"short": "Hash of the data (sha-1, base64ed)",
"mapping": [ {
"map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "Library.content:elmJsonContent.hash",
"comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.hash"
},
"isSummary": true
}, {
"path": "Library.content.title",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min": 0,
"definition": "A label or set of text to display in place of the data.",
"short": "Label to display in place of the data",
"mapping": [ {
"map": "./title/data",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Library.content:elmJsonContent.title",
"example": [ {
"label": "General",
"valueString": "Official Corporate Logo"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.title"
},
"isSummary": true
}, {
"path": "Library.content.creation",
"requirements": "This is often tracked as an integrity issue for use of the attachment.",
"min": 0,
"definition": "The date that the attachment was first created.",
"short": "Date attachment was first created",
"mapping": [ {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Library.content:elmJsonContent.creation",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.creation"
},
"isSummary": true
} ]
},
"status": "active",
"id": "bf0222cd-54e1-4205-9d16-3554f5f00886",
"kind": "resource",
"url": "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/library-cqfm",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "Library",
"path": "Library",
"mustSupport": false
}, {
"id": "Library.extension:comment",
"max": "*",
"min": 0,
"path": "Library.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment"
} ],
"sliceName": "comment",
"mustSupport": true
}, {
"id": "Library.url",
"max": "1",
"min": 1,
"path": "Library.url",
"mustSupport": true,
"requirements": "A published library must have a canonical url defined."
}, {
"id": "Library.identifier",
"max": "*",
"min": 1,
"path": "Library.identifier",
"mustSupport": true,
"requirements": "A published library must have at least one identifier defined."
}, {
"id": "Library.version",
"max": "1",
"min": 1,
"path": "Library.version",
"mustSupport": true,
"requirements": "A published library must specify a content version."
}, {
"id": "Library.name",
"max": "1",
"min": 1,
"path": "Library.name",
"mustSupport": true,
"requirements": "A published library must specify a valid, machine-friendly name."
}, {
"id": "Library.title",
"max": "1",
"min": 1,
"path": "Library.title",
"mustSupport": true,
"requirements": "A published library must specify a human-friendly title."
}, {
"id": "Library.date",
"max": "1",
"min": 1,
"path": "Library.date",
"mustSupport": true,
"requirements": "A published library must specify the date the library content was last changed."
}, {
"id": "Library.publisher",
"max": "1",
"min": 1,
"path": "Library.publisher",
"mustSupport": true,
"requirements": "A published library must provide publisher information."
}, {
"id": "Library.description",
"max": "1",
"min": 1,
"path": "Library.description",
"mustSupport": true,
"requirements": "A published library must provide a concise description of the library content."
}, {
"id": "Library.purpose",
"path": "Library.purpose",
"mustSupport": true,
"requirements": "A published library should provide a clear description of the purpose of the library."
}, {
"id": "Library.usage",
"path": "Library.usage",
"mustSupport": true,
"requirements": "A published library should provide clinical usage notes for the library."
}, {
"id": "Library.approvalDate",
"max": "1",
"min": 1,
"path": "Library.approvalDate",
"mustSupport": true,
"requirements": "A published library must indicate the date the library content was approved by the publisher."
}, {
"id": "Library.lastReviewDate",
"max": "1",
"min": 1,
"path": "Library.lastReviewDate",
"mustSupport": true,
"requirements": "A published library must indicate when the library content was last reviewed."
}, {
"id": "Library.effectivePeriod",
"path": "Library.effectivePeriod",
"mustSupport": true,
"requirements": "A published library should provide an indication of the period during which the library content can be effectively applied."
}, {
"id": "Library.useContext",
"path": "Library.useContext",
"mustSupport": true,
"requirements": "A published library should provide a clear indication of the expected contexts of use for the library content."
}, {
"id": "Library.jurisdiction",
"path": "Library.jurisdiction",
"mustSupport": true,
"requirements": "A published library should indicate intended jurisdictions for the library content."
}, {
"id": "Library.topic",
"path": "Library.topic",
"mustSupport": true,
"requirements": "A published library should provide relevant topics for the library content."
}, {
"id": "Library.contributor",
"path": "Library.contributor",
"mustSupport": true,
"requirements": "A published library should provide information on contributors to the library content."
}, {
"id": "Library.contact",
"max": "*",
"min": 1,
"path": "Library.contact",
"mustSupport": true,
"requirements": "A published library must provide contact information for the publisher."
}, {
"id": "Library.copyright",
"path": "Library.copyright",
"mustSupport": true,
"requirements": "A published library should provide copyright information for the library content."
}, {
"id": "Library.relatedArtifact",
"path": "Library.relatedArtifact",
"short": "Any referenced CQL libraries or additional documentation, citations, etc.",
"definition": "Any referenced CQL libraries or additional documentation, citations, etc.",
"mustSupport": true,
"requirements": "A published library should provide related information such as supporting evidence, citations, and documentation."
}, {
"id": "Library.parameter",
"path": "Library.parameter",
"mustSupport": true,
"requirements": "A published library should provide a description of any parameters defined by the library."
}, {
"id": "Library.dataRequirement",
"path": "Library.dataRequirement",
"mustSupport": true,
"requirements": "A published library should provide a description of the data requirements for logic contained in the library."
}, {
"id": "Library.content",
"path": "Library.content",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "contentType",
"type": "value"
} ]
},
"mustSupport": false
}, {
"id": "Library.content:cqlContent",
"max": "*",
"min": 1,
"path": "Library.content",
"sliceName": "cqlContent",
"mustSupport": true,
"requirements": "A published library must provide the contents of the library in at least one media format."
}, {
"id": "Library.content:cqlContent.contentType",
"max": "1",
"min": 1,
"path": "Library.content.contentType",
"type": [ {
"code": "code"
} ],
"fixedCode": "text/cql",
"mustSupport": true
}, {
"id": "Library.content:elmXmlContent",
"max": "*",
"min": 0,
"path": "Library.content",
"sliceName": "elmXmlContent",
"mustSupport": true,
"requirements": "A published library must provide the contents of the library in at least one media format."
}, {
"id": "Library.content:elmXmlContent.contentType",
"max": "1",
"min": 1,
"path": "Library.content.contentType",
"type": [ {
"code": "code"
} ],
"fixedCode": "application/elm+xml",
"mustSupport": true
}, {
"id": "Library.content:elmJsonContent",
"max": "*",
"min": 0,
"path": "Library.content",
"sliceName": "elmJsonContent",
"mustSupport": true,
"requirements": "A published library must provide the contents of the library in at least one media format."
}, {
"id": "Library.content:elmJsonContent.contentType",
"max": "1",
"min": 1,
"path": "Library.content.contentType",
"type": [ {
"code": "code"
} ],
"fixedCode": "application/elm+json",
"mustSupport": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/CQI",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Library"
}