STU3 Candidate
Clinical ReasoningThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
StructureDefinition for library
{
"resourceType": "StructureDefinition",
"id": "Library",
"meta": {
"lastUpdated": "2016-12-06T12:22:34.981+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cds"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Library",
"name": "Library",
"status": "draft",
"publisher": "Health Level Seven International (Clinical Decision Support)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/dss/index.cfm"
}
]
}
],
"date": "2016-12-06T12:22:34+11:00",
"description": "Base StructureDefinition for Library Resource",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Library",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "Library",
"path": "Library",
"short": "Represents a library of quality improvement components",
"definition": "The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose exist knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "Library.id",
"path": "Library.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Library.meta",
"path": "Library.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "Library.implicitRules",
"path": "Library.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "Library.language",
"path": "Library.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "Library.text",
"path": "Library.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"comments": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Library.contained",
"path": "Library.contained",
"short": "Contained, inline Resources",
"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.",
"comments": "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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Library.extension",
"path": "Library.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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.",
"comments": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Library.modifierExtension",
"path": "Library.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Library.url",
"path": "Library.url",
"short": "Logical uri to reference this library (globally unique)",
"definition": "An absolute URL 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](resource.html#versions).",
"comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.",
"requirements": "Allows the library to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Library.identifier",
"path": "Library.identifier",
"short": "Additional identifier for the library",
"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.",
"comments": "Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this library outside of FHIR, where the logical URL is not possible to use.",
"requirements": "Allows externally provided and/or useable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Library.version",
"path": "Library.version",
"short": "Business version of the library",
"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 are orderable. 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.",
"comments": "There may be multiple different instances of a library that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "Library.name",
"path": "Library.name",
"short": "Name for this library (Computer friendly)",
"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.",
"comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.",
"requirements": "Support human navigation & code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "Library.title",
"path": "Library.title",
"short": "Name for this library (Human friendly)",
"definition": "A short, descriptive, user-friendly title for the library.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "Library.type",
"path": "Library.type",
"short": "logic-library | model-definition | asset-collection | module-definition",
"definition": "Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of knowledge asset this library contains",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/library-type"
}
},
"mapping": [
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Library.status",
"path": "Library.status",
"short": "draft | active | retired",
"definition": "The status of this library. Enables tracking the life-cycle of the content.",
"comments": "Allows filtering of library that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Library.experimental",
"path": "Library.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this library is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of library that are appropriate for use vs. not.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level library would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Library.date",
"path": "Library.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the library was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.",
"comments": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "Library.description",
"path": "Library.description",
"short": "Natural language description of the library",
"definition": "A free text natural language description of the library from the consumer's perspective.",
"comments": "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 module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "Library.purpose",
"path": "Library.purpose",
"short": "Why this library is defined",
"definition": "Explains why this library is needed and why it has been designed as it has.",
"comments": "This element does not describe the usage of the library (See, e.g, the comments element, or relatedArtifacts), rather it's for 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.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "Library.usage",
"path": "Library.usage",
"short": "Describes the clinical usage of the library",
"definition": "A detailed description of how the library is used from a clinical perspective.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Library.approvalDate",
"path": "Library.approvalDate",
"short": "When library approved by publisher",
"definition": "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comments": "The date may be more recent than the approval date because of minor changes / editorial corrections.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Library.lastReviewDate",
"path": "Library.lastReviewDate",
"short": "Last review date for the library",
"definition": "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.",
"comments": "If specified, this is usually after the approval date.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Library.effectivePeriod",
"path": "Library.effectivePeriod",
"short": "The effective date range for the library",
"definition": "The period during which the library content was or is planned to be effective.",
"comments": "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 would be published in 2015.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Library.useContext",
"path": "Library.useContext",
"short": "Content intends to support these contexts",
"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 of code system definitions.",
"comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "Library.jurisdiction",
"path": "Library.jurisdiction",
"short": "Intended jurisdiction for library (if applicable)",
"definition": "A jurisdiction in which the library is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "Library.topic",
"path": "Library.topic",
"short": "Descriptional topics for the library",
"definition": "Clinical topics related to the content of the library.",
"requirements": "Repositories must be able to determine how to categorize the library so that it can be found by topical searches.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Library.contributor",
"path": "Library.contributor",
"short": "A content contributor",
"definition": "A contributor to the content of the library, including authors, editors, reviewers, and endorsers.",
"requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the library.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contributor"
}
]
},
{
"id": "Library.publisher",
"path": "Library.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the library.",
"comments": "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.",
"requirements": "Helps establish the \"authority/credibility\" of the library. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "Library.contact",
"path": "Library.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "Library.copyright",
"path": "Library.copyright",
"short": "Use and/or publishing restrictions",
"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.",
"requirements": "Consumers of the library must be able to determine any legal restrictions on the use of the library and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Library.relatedArtifact",
"path": "Library.relatedArtifact",
"short": "Related artifacts for the library",
"definition": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comments": "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements": "Libraries must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedArtifact"
}
]
},
{
"id": "Library.parameter",
"path": "Library.parameter",
"short": "Parameters defined by the library",
"definition": "The parameter element defines parameters used by the library.",
"min": 0,
"max": "*",
"type": [
{
"code": "ParameterDefinition"
}
]
},
{
"id": "Library.dataRequirement",
"path": "Library.dataRequirement",
"short": "Data requirements of the library",
"definition": "Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
},
{
"id": "Library.content",
"path": "Library.content",
"short": "The content of the library",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Library",
"path": "Library",
"short": "Represents a library of quality improvement components",
"definition": "The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose exist knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "Library.url",
"path": "Library.url",
"short": "Logical uri to reference this library (globally unique)",
"definition": "An absolute URL 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](resource.html#versions).",
"comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.",
"requirements": "Allows the library to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Library.identifier",
"path": "Library.identifier",
"short": "Additional identifier for the library",
"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.",
"comments": "Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this library outside of FHIR, where the logical URL is not possible to use.",
"requirements": "Allows externally provided and/or useable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Library.version",
"path": "Library.version",
"short": "Business version of the library",
"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 are orderable. 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.",
"comments": "There may be multiple different instances of a library that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "Library.name",
"path": "Library.name",
"short": "Name for this library (Computer friendly)",
"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.",
"comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.",
"requirements": "Support human navigation & code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "Library.title",
"path": "Library.title",
"short": "Name for this library (Human friendly)",
"definition": "A short, descriptive, user-friendly title for the library.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "Library.type",
"path": "Library.type",
"short": "logic-library | model-definition | asset-collection | module-definition",
"definition": "Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of knowledge asset this library contains",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/library-type"
}
},
"mapping": [
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Library.status",
"path": "Library.status",
"short": "draft | active | retired",
"definition": "The status of this library. Enables tracking the life-cycle of the content.",
"comments": "Allows filtering of library that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Library.experimental",
"path": "Library.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this library is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of library that are appropriate for use vs. not.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level library would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Library.date",
"path": "Library.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the library was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.",
"comments": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "Library.description",
"path": "Library.description",
"short": "Natural language description of the library",
"definition": "A free text natural language description of the library from the consumer's perspective.",
"comments": "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 module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "Library.purpose",
"path": "Library.purpose",
"short": "Why this library is defined",
"definition": "Explains why this library is needed and why it has been designed as it has.",
"comments": "This element does not describe the usage of the library (See, e.g, the comments element, or relatedArtifacts), rather it's for 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.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "Library.usage",
"path": "Library.usage",
"short": "Describes the clinical usage of the library",
"definition": "A detailed description of how the library is used from a clinical perspective.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Library.approvalDate",
"path": "Library.approvalDate",
"short": "When library approved by publisher",
"definition": "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comments": "The date may be more recent than the approval date because of minor changes / editorial corrections.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Library.lastReviewDate",
"path": "Library.lastReviewDate",
"short": "Last review date for the library",
"definition": "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.",
"comments": "If specified, this is usually after the approval date.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Library.effectivePeriod",
"path": "Library.effectivePeriod",
"short": "The effective date range for the library",
"definition": "The period during which the library content was or is planned to be effective.",
"comments": "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 would be published in 2015.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Library.useContext",
"path": "Library.useContext",
"short": "Content intends to support these contexts",
"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 of code system definitions.",
"comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "Library.jurisdiction",
"path": "Library.jurisdiction",
"short": "Intended jurisdiction for library (if applicable)",
"definition": "A jurisdiction in which the library is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "Library.topic",
"path": "Library.topic",
"short": "Descriptional topics for the library",
"definition": "Clinical topics related to the content of the library.",
"requirements": "Repositories must be able to determine how to categorize the library so that it can be found by topical searches.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Library.contributor",
"path": "Library.contributor",
"short": "A content contributor",
"definition": "A contributor to the content of the library, including authors, editors, reviewers, and endorsers.",
"requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the library.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contributor"
}
]
},
{
"id": "Library.publisher",
"path": "Library.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the library.",
"comments": "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.",
"requirements": "Helps establish the \"authority/credibility\" of the library. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "Library.contact",
"path": "Library.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "Library.copyright",
"path": "Library.copyright",
"short": "Use and/or publishing restrictions",
"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.",
"requirements": "Consumers of the library must be able to determine any legal restrictions on the use of the library and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Library.relatedArtifact",
"path": "Library.relatedArtifact",
"short": "Related artifacts for the library",
"definition": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comments": "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements": "Libraries must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedArtifact"
}
]
},
{
"id": "Library.parameter",
"path": "Library.parameter",
"short": "Parameters defined by the library",
"definition": "The parameter element defines parameters used by the library.",
"min": 0,
"max": "*",
"type": [
{
"code": "ParameterDefinition"
}
]
},
{
"id": "Library.dataRequirement",
"path": "Library.dataRequirement",
"short": "Data requirements of the library",
"definition": "Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
},
{
"id": "Library.content",
"path": "Library.content",
"short": "The content of the library",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:26+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change