Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Library | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_Library_R4B | ||
This cross-version profile allows STU3 Library content to be represented via FHIR R4B Library resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Library(4.3.0) | Represents a library of quality improvement components Constraints: cnl-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.contributor Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Library.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Library.type | Base | extensible | LibraryType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Library | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Library.implicitRules, Library.extension, Library.extension:contributor, Library.modifierExtension, Library.status, Library.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Library.extension, Library.extension:contributor, Library.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Library
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Library(4.3.0) | Represents a library of quality improvement components Constraints: cnl-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.contributor Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the library | ||||
![]() ![]() |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the library | |||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. | ||||
![]() ![]() |
0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.contact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of an individual to contact | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the library | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | UsageContext | STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.useContext Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Why this library is defined | |||||
![]() ![]() |
0..1 | string | Describes the clinical usage of the library | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | date | When the library was approved by publisher | |||||
![]() ![]() |
0..1 | date | When the library was last reviewed | |||||
![]() ![]() |
Σ | 0..1 | Period | When the library is expected to be used | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | STU3: effectivePeriod additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.effectivePeriod Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | RelatedArtifact | STU3: relatedArtifact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.relatedArtifact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Short label | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Brief description of the related artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
![]() ![]() ![]() |
Σ | 0..1 | Attachment | What document is being referenced | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
![]() ![]() |
0..* | ParameterDefinition | Parameters defined by the library | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | ParameterDefinition | STU3: parameter additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.parameter Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | Name used to access the parameter value | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | in | out Binding: OperationParameterUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | integer | Minimum cardinality | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Maximum cardinality (a number of *) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | A brief description of the parameter | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | What type of value Binding: FHIRAllTypes (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(StructureDefinition) | What profile the value is expected to be | ||||
![]() ![]() |
0..* | DataRequirement | What data is referenced by this library | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | DataRequirement | STU3: dataRequirement additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.dataRequirement Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required) | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
![]() ![]() ![]() |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
![]() ![]() ![]() |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | What code is expected | ||||
![]() ![]() ![]() |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date valued parameter to search on | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of results | ||||
![]() ![]() ![]() |
Σ | 0..* | Element | Order of the results | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required) | ||||
![]() ![]() |
Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Attachment | STU3: content additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.content Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): IETF language tag
Example General: en-AU | ||||
![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Library.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Library.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Library.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Library.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Library.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Library.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Library.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Library.type | Base | extensible | LibraryType | 📍4.3.0 | FHIR Std. |
| Library.subject[x] | Base | extensible | Subject type | 📍4.3.0 | FHIR Std. |
| Library.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| Library.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| Library.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| Library.topic | Base | example | DefinitionTopic | 📍4.3.0 | FHIR Std. |
| Library.relatedArtifact.type | Base | required | RelatedArtifactType | 📍4.3.0 | FHIR Std. |
| Library.parameter.use | Base | required | OperationParameterUse | 📍4.3.0 | FHIR Std. |
| Library.parameter.type | Base | required | FHIRAllTypes | 📍4.3.0 | FHIR Std. |
| Library.dataRequirement.type | Base | required | FHIRAllTypes | 📍4.3.0 | FHIR Std. |
| Library.dataRequirement.subject[x] | Base | extensible | Subject type | 📍4.3.0 | FHIR Std. |
| Library.dataRequirement.sort.direction | Base | required | SortDirection | 📍4.3.0 | FHIR Std. |
| Library.content.contentType | Base | required | MimeType | 📍4.3.0 | FHIR Std. |
| Library.content.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Library | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Library.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| drq-1 | error | Library.dataRequirement.codeFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| drq-2 | error | Library.dataRequirement.dateFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| ele-1 | error | Library.meta, Library.meta.extension, Library.meta.extension:meta, Library.meta.versionId, Library.meta.lastUpdated, Library.meta.source, Library.meta.profile, Library.meta.security, Library.meta.tag, Library.implicitRules, Library.language, Library.text, Library.text.extension, Library.text.extension:text, Library.text.status, Library.text.div, Library.extension, Library.extension:contributor, Library.modifierExtension, Library.url, Library.identifier, Library.identifier.extension, Library.identifier.extension:identifier, Library.identifier.use, Library.identifier.type, Library.identifier.system, Library.identifier.value, Library.identifier.period, Library.identifier.assigner, Library.version, Library.name, Library.title, Library.subtitle, Library.status, Library.experimental, Library.type, Library.subject[x], Library.date, Library.publisher, Library.contact, Library.contact.extension, Library.contact.extension:contact, Library.contact.name, Library.contact.telecom, Library.description, Library.useContext, Library.useContext.extension, Library.useContext.extension:useContext, Library.useContext.code, Library.useContext.value[x], Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.effectivePeriod.extension, Library.effectivePeriod.extension:effectivePeriod, Library.effectivePeriod.start, Library.effectivePeriod.end, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.relatedArtifact.extension, Library.relatedArtifact.extension:relatedArtifact, Library.relatedArtifact.type, Library.relatedArtifact.label, Library.relatedArtifact.display, Library.relatedArtifact.citation, Library.relatedArtifact.url, Library.relatedArtifact.document, Library.relatedArtifact.resource, Library.parameter, Library.parameter.extension, Library.parameter.extension:parameter, Library.parameter.name, Library.parameter.use, Library.parameter.min, Library.parameter.max, Library.parameter.documentation, Library.parameter.type, Library.parameter.profile, Library.dataRequirement, Library.dataRequirement.extension, Library.dataRequirement.extension:dataRequirement, Library.dataRequirement.type, Library.dataRequirement.profile, Library.dataRequirement.subject[x], Library.dataRequirement.mustSupport, Library.dataRequirement.codeFilter, Library.dataRequirement.codeFilter.extension, Library.dataRequirement.codeFilter.path, Library.dataRequirement.codeFilter.searchParam, Library.dataRequirement.codeFilter.valueSet, Library.dataRequirement.codeFilter.code, Library.dataRequirement.dateFilter, Library.dataRequirement.dateFilter.extension, Library.dataRequirement.dateFilter.path, Library.dataRequirement.dateFilter.searchParam, Library.dataRequirement.dateFilter.value[x], Library.dataRequirement.limit, Library.dataRequirement.sort, Library.dataRequirement.sort.extension, Library.dataRequirement.sort.path, Library.dataRequirement.sort.direction, Library.content, Library.content.extension, Library.content.extension:content, Library.content.contentType, Library.content.language, Library.content.data, Library.content.url, Library.content.size, Library.content.hash, Library.content.title, Library.content.creation | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Library.meta.extension, Library.meta.extension:meta, Library.text.extension, Library.text.extension:text, Library.extension, Library.extension:contributor, Library.modifierExtension, Library.identifier.extension, Library.identifier.extension:identifier, Library.contact.extension, Library.contact.extension:contact, Library.useContext.extension, Library.useContext.extension:useContext, Library.effectivePeriod.extension, Library.effectivePeriod.extension:effectivePeriod, Library.relatedArtifact.extension, Library.relatedArtifact.extension:relatedArtifact, Library.parameter.extension, Library.parameter.extension:parameter, Library.dataRequirement.extension, Library.dataRequirement.extension:dataRequirement, Library.dataRequirement.codeFilter.extension, Library.dataRequirement.dateFilter.extension, Library.dataRequirement.sort.extension, Library.content.extension, Library.content.extension:content | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Library.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Library.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Library
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Library(4.3.0) | Represents a library of quality improvement components Constraints: cnl-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.contributor Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Library.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Library.type | Base | extensible | LibraryType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Library | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Library.implicitRules, Library.extension, Library.extension:contributor, Library.modifierExtension, Library.status, Library.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Library.extension, Library.extension:contributor, Library.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Library
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Library(4.3.0) | Represents a library of quality improvement components Constraints: cnl-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.contributor Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the library | ||||
![]() ![]() |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the library | |||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. | ||||
![]() ![]() |
0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.contact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of an individual to contact | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the library | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | UsageContext | STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.useContext Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Why this library is defined | |||||
![]() ![]() |
0..1 | string | Describes the clinical usage of the library | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | date | When the library was approved by publisher | |||||
![]() ![]() |
0..1 | date | When the library was last reviewed | |||||
![]() ![]() |
Σ | 0..1 | Period | When the library is expected to be used | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | STU3: effectivePeriod additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.effectivePeriod Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | RelatedArtifact | STU3: relatedArtifact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.relatedArtifact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Short label | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Brief description of the related artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
![]() ![]() ![]() |
Σ | 0..1 | Attachment | What document is being referenced | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
![]() ![]() |
0..* | ParameterDefinition | Parameters defined by the library | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | ParameterDefinition | STU3: parameter additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.parameter Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | Name used to access the parameter value | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | in | out Binding: OperationParameterUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | integer | Minimum cardinality | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Maximum cardinality (a number of *) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | A brief description of the parameter | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | What type of value Binding: FHIRAllTypes (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(StructureDefinition) | What profile the value is expected to be | ||||
![]() ![]() |
0..* | DataRequirement | What data is referenced by this library | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | DataRequirement | STU3: dataRequirement additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.dataRequirement Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required) | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
![]() ![]() ![]() |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
![]() ![]() ![]() |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | What code is expected | ||||
![]() ![]() ![]() |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date valued parameter to search on | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of results | ||||
![]() ![]() ![]() |
Σ | 0..* | Element | Order of the results | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required) | ||||
![]() ![]() |
Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Attachment | STU3: content additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Library.content Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): IETF language tag
Example General: en-AU | ||||
![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Library.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Library.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Library.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Library.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Library.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Library.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Library.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Library.type | Base | extensible | LibraryType | 📍4.3.0 | FHIR Std. |
| Library.subject[x] | Base | extensible | Subject type | 📍4.3.0 | FHIR Std. |
| Library.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| Library.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| Library.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| Library.topic | Base | example | DefinitionTopic | 📍4.3.0 | FHIR Std. |
| Library.relatedArtifact.type | Base | required | RelatedArtifactType | 📍4.3.0 | FHIR Std. |
| Library.parameter.use | Base | required | OperationParameterUse | 📍4.3.0 | FHIR Std. |
| Library.parameter.type | Base | required | FHIRAllTypes | 📍4.3.0 | FHIR Std. |
| Library.dataRequirement.type | Base | required | FHIRAllTypes | 📍4.3.0 | FHIR Std. |
| Library.dataRequirement.subject[x] | Base | extensible | Subject type | 📍4.3.0 | FHIR Std. |
| Library.dataRequirement.sort.direction | Base | required | SortDirection | 📍4.3.0 | FHIR Std. |
| Library.content.contentType | Base | required | MimeType | 📍4.3.0 | FHIR Std. |
| Library.content.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Library | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Library.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| drq-1 | error | Library.dataRequirement.codeFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| drq-2 | error | Library.dataRequirement.dateFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| ele-1 | error | Library.meta, Library.meta.extension, Library.meta.extension:meta, Library.meta.versionId, Library.meta.lastUpdated, Library.meta.source, Library.meta.profile, Library.meta.security, Library.meta.tag, Library.implicitRules, Library.language, Library.text, Library.text.extension, Library.text.extension:text, Library.text.status, Library.text.div, Library.extension, Library.extension:contributor, Library.modifierExtension, Library.url, Library.identifier, Library.identifier.extension, Library.identifier.extension:identifier, Library.identifier.use, Library.identifier.type, Library.identifier.system, Library.identifier.value, Library.identifier.period, Library.identifier.assigner, Library.version, Library.name, Library.title, Library.subtitle, Library.status, Library.experimental, Library.type, Library.subject[x], Library.date, Library.publisher, Library.contact, Library.contact.extension, Library.contact.extension:contact, Library.contact.name, Library.contact.telecom, Library.description, Library.useContext, Library.useContext.extension, Library.useContext.extension:useContext, Library.useContext.code, Library.useContext.value[x], Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.effectivePeriod.extension, Library.effectivePeriod.extension:effectivePeriod, Library.effectivePeriod.start, Library.effectivePeriod.end, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.relatedArtifact.extension, Library.relatedArtifact.extension:relatedArtifact, Library.relatedArtifact.type, Library.relatedArtifact.label, Library.relatedArtifact.display, Library.relatedArtifact.citation, Library.relatedArtifact.url, Library.relatedArtifact.document, Library.relatedArtifact.resource, Library.parameter, Library.parameter.extension, Library.parameter.extension:parameter, Library.parameter.name, Library.parameter.use, Library.parameter.min, Library.parameter.max, Library.parameter.documentation, Library.parameter.type, Library.parameter.profile, Library.dataRequirement, Library.dataRequirement.extension, Library.dataRequirement.extension:dataRequirement, Library.dataRequirement.type, Library.dataRequirement.profile, Library.dataRequirement.subject[x], Library.dataRequirement.mustSupport, Library.dataRequirement.codeFilter, Library.dataRequirement.codeFilter.extension, Library.dataRequirement.codeFilter.path, Library.dataRequirement.codeFilter.searchParam, Library.dataRequirement.codeFilter.valueSet, Library.dataRequirement.codeFilter.code, Library.dataRequirement.dateFilter, Library.dataRequirement.dateFilter.extension, Library.dataRequirement.dateFilter.path, Library.dataRequirement.dateFilter.searchParam, Library.dataRequirement.dateFilter.value[x], Library.dataRequirement.limit, Library.dataRequirement.sort, Library.dataRequirement.sort.extension, Library.dataRequirement.sort.path, Library.dataRequirement.sort.direction, Library.content, Library.content.extension, Library.content.extension:content, Library.content.contentType, Library.content.language, Library.content.data, Library.content.url, Library.content.size, Library.content.hash, Library.content.title, Library.content.creation | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Library.meta.extension, Library.meta.extension:meta, Library.text.extension, Library.text.extension:text, Library.extension, Library.extension:contributor, Library.modifierExtension, Library.identifier.extension, Library.identifier.extension:identifier, Library.contact.extension, Library.contact.extension:contact, Library.useContext.extension, Library.useContext.extension:useContext, Library.effectivePeriod.extension, Library.effectivePeriod.extension:effectivePeriod, Library.relatedArtifact.extension, Library.relatedArtifact.extension:relatedArtifact, Library.parameter.extension, Library.parameter.extension:parameter, Library.dataRequirement.extension, Library.dataRequirement.extension:dataRequirement, Library.dataRequirement.codeFilter.extension, Library.dataRequirement.dateFilter.extension, Library.dataRequirement.sort.extension, Library.content.extension, Library.content.extension:content | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Library.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Library.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Library
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron