| OntarioEFormsLiquidLibrary (Library) | C | | Library | Element idLibrary Short descriptionOntario eForms Liquid Library DefinitionA Library resource carrying a Liquid template for QuestionnaireResponse narrative generation.
Data typeLibrary Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-4: 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-3: 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
name.matches('[A-Z]([A-Za-z0-9_]){0,254}') Mappings- rim: Entity. Role, or Act
- rim: Act[classCode=GROUPER;moodCode=EVN]
|
| id | Σ | 1..1 | idFixed Value | Element idLibrary.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typeid ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Fixed valueliquid Mappings |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idLibrary.meta Short descriptionMetadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Data typeMeta ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLibrary.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
CommentsAsserting 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idLibrary.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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).
Data typecode BindingA human language. CommonLanguages (preferred) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| text | | 0..1 | Narrative | There are no (further) constraints on this element Element idLibrary.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can 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.
CommentsContained 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 information is added later.
Data typeNarrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idLibrary.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
CommentsThis 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Data typeResource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idLibrary.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idLibrary.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | Σ | 0..1 | uri | There are no (further) constraints on this element Element idLibrary.url Short descriptionCanonical identifier for this library, represented as a URI (globally unique) DefinitionAn absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.
RequirementsAllows the library to be referenced by a single globally unique identifier.
CommentsCan be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.url
- w5: FiveWs.identifier
- rim: .identifier[scope=BUSN;reliability=ISS]
|
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idLibrary.identifier Short descriptionAdditional identifier for the library DefinitionA 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.
RequirementsAllows externally provided and/or usable business identifiers to be easily associated with the module.
CommentsTypically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.
Data typeIdentifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- workflow: Definition.identifier
- w5: FiveWs.identifier
- rim: .identifier
- objimpl: no-gen-base
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idLibrary.version Short descriptionBusiness version of the library DefinitionThe identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
CommentsThere may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version].
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.version
- w5: FiveWs.version
- rim: N/A (to add?)
|
| name | Σ C | 0..1 | string | There are no (further) constraints on this element Element idLibrary.name Short descriptionName for this library (computer friendly) DefinitionA 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.
RequirementsSupport human navigation and code generation.
CommentsThe name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, inv-0 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| title | Σ | 0..1 | string | There are no (further) constraints on this element Element idLibrary.title Short descriptionName for this library (human friendly) DefinitionA short, descriptive, user-friendly title for the library.
CommentsThis name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.title
- rim: .title
|
| subtitle | | 0..1 | string | There are no (further) constraints on this element Element idLibrary.subtitle Short descriptionSubordinate title of the library DefinitionAn explanatory or alternate title for the library giving additional information about its content.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| status | Σ ?! | 1..1 | codeBindingPattern | Element idLibrary.status Short descriptiondraft | active | retired | unknown DefinitionThe status of this library. Enables tracking the life-cycle of the content.
CommentsAllows filtering of libraries that are appropriate for use vs. not.
Data typecode BindingThe lifecycle status of an artifact. PublicationStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Patternactive Mappings- rim: n/a
- workflow: Definition.status
- w5: FiveWs.status
- rim: .status
|
| experimental | O Σ | 1..1 | boolean | Element idLibrary.experimental Short descriptionSet to 'false' for real forms DefinitionA Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
RequirementsUsed to differentiate Questionnaires defined for 'testing' purposes from those that are intended for actual use with patients
CommentsAllows filtering of librarys that are appropriate for use versus not.
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.experimental
- w5: FiveWs.class
- rim: N/A (to add?)
Obligations| Actor | Code |
|---|
| http://ontariohealth.ca/fhir/eforms/ActorDefinition/qr-narrative-generator | SHALL:process |
|
| type | Σ | 1..1 | CodeableConceptBindingPattern | Element idLibrary.type Short descriptionlogic-library | model-definition | asset-collection | module-definition DefinitionIdentifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingThe type of knowledge asset this library contains. LibraryType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Pattern{
"coding": [
{
"system": "http://ontariohealth.ca/fhir/eforms/CodeSystem/library-types",
"code": "qr-narrative-liquid"
}
]
}Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- rim: .code
|
| subject[x] | | 0..1 | Binding | There are no (further) constraints on this element Element idLibrary.subject[x] Short descriptionType of individual the library content is focused on DefinitionA code or group definition that describes the intended subject of the contents of the library.
Meaning when missingBindingThe possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). SubjectType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| subjectCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
| subjectReference | | | Reference(Group) | There are no (further) constraints on this element Data typeReference(Group) |
| date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idLibrary.date Short descriptionDate last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.
CommentsNote that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.date
- w5: FiveWs.recorded
- rim: .participation[typeCode=AUT].time
|
| publisher | Σ | 0..1 | string | There are no (further) constraints on this element Element idLibrary.publisher Short descriptionName of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the library.
RequirementsHelps establish the "authority/credibility" of the library. May also allow for contact.
CommentsUsually 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.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.publisher
- w5: FiveWs.witness
- rim: .participation[typeCode=AUT].role
|
| contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element idLibrary.contact Short descriptionContact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher.
CommentsMay be a web site, an email address, a telephone number, etc.
Data typeContactDetail ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.contact
- rim: .participation[typeCode=CALLBCK].role
|
| description | Σ | 0..1 | markdown | There are no (further) constraints on this element Element idLibrary.description Short descriptionNatural language description of the library DefinitionA free text natural language description of the library from a consumer's perspective.
CommentsThis description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).
Data typemarkdown ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.description
- rim: .text
|
| useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element idLibrary.useContext Short descriptionThe context that the content is intended to support DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.
RequirementsAssist in searching for appropriate content.
CommentsWhen multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Data typeUsageContext ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.useContext
- rim: N/A (to add?)
|
| jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idLibrary.jurisdiction Short descriptionIntended jurisdiction for library (if applicable) DefinitionA legal or geographic region in which the library is intended to be used.
CommentsIt may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
Data typeCodeableConcept BindingCountries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: Definition.jurisdiction
- rim: N/A (to add?)
|
| purpose | | 0..1 | markdown | There are no (further) constraints on this element Element idLibrary.purpose Short descriptionWhy this library is defined DefinitionExplanation of why this library is needed and why it has been designed as it has.
CommentsThis element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.
Data typemarkdown ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.purpose
- w5: FiveWs.why[x]
- rim: .reasonCode.text
- objimpl: no-gen-base
|
| usage | | 0..1 | string | There are no (further) constraints on this element Element idLibrary.usage Short descriptionDescribes the clinical usage of the library DefinitionA detailed description of how the library is used from a clinical perspective.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A (to add?)
|
| copyright | | 0..1 | markdown | There are no (further) constraints on this element Element idLibrary.copyright Short descriptionUse and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.
RequirementsConsumers must be able to determine any legal restrictions on the use of the library and/or its content.
CommentsSystems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
Data typemarkdown ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.copyright
- rim: N/A (to add?)
- objimpl: no-gen-base
|
| approvalDate | | 0..1 | date | There are no (further) constraints on this element Element idLibrary.approvalDate Short descriptionWhen the library was approved by publisher DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
CommentsThe 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
Data typedate ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.approvalDate
- rim: .outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime
- objimpl: no-gen-base
|
| lastReviewDate | | 0..1 | date | There are no (further) constraints on this element Element idLibrary.lastReviewDate Short descriptionWhen the library was last reviewed DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
RequirementsGives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
CommentsIf specified, this date follows the original approval date.
Data typedate ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- workflow: Definition.lastReviewDate
- rim: .outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime
- objimpl: no-gen-base
|
| effectivePeriod | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idLibrary.effectivePeriod Short descriptionWhen the library is expected to be used DefinitionThe period during which the library content was or is planned to be in active use.
RequirementsAllows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the library are or are expected to be used instead.
CommentsThe effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- workflow: Definition.effectivePeriod
- rim: N/A (to add?)
- objimpl: no-gen-base
|
| topic | | 0..* | CodeableConcept | There are no (further) constraints on this element Element idLibrary.topic Short descriptionE.g. Education, Treatment, Assessment, etc. DefinitionDescriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.
RequirementsRepositories must be able to determine how to categorize the library so that it can be found by topical searches.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingHigh-level categorization of the definition, used for searching, sorting, and filtering. DefinitionTopic (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: N/A (to add?)
|
| author | | 0..* | ContactDetail | There are no (further) constraints on this element Element idLibrary.author Short descriptionWho authored the content DefinitionAn individiual or organization primarily involved in the creation and maintenance of the content.
Data typeContactDetail ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: .participation[typeCode=AUT]
|
| editor | | 0..* | ContactDetail | There are no (further) constraints on this element Element idLibrary.editor Short descriptionWho edited the content DefinitionAn individual or organization primarily responsible for internal coherence of the content.
Data typeContactDetail ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| reviewer | | 0..* | ContactDetail | There are no (further) constraints on this element Element idLibrary.reviewer Short descriptionWho reviewed the content DefinitionAn individual or organization primarily responsible for review of some aspect of the content.
Data typeContactDetail ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: .participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}
|
| endorser | | 0..* | ContactDetail | There are no (further) constraints on this element Element idLibrary.endorser Short descriptionWho endorsed the content DefinitionAn individual or organization responsible for officially endorsing the content for use in some setting.
Data typeContactDetail ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: .participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}
|
| relatedArtifact | | 0..* | RelatedArtifact | There are no (further) constraints on this element Element idLibrary.relatedArtifact Short descriptionAdditional documentation, citations, etc. DefinitionRelated artifacts such as additional documentation, justification, or bibliographic references.
RequirementsLibraries 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.
CommentsEach related artifact is either an attachment, or a reference to another resource, but not both.
Data typeRelatedArtifact ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: .outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}
|
| parameter | | 0..* | ParameterDefinition | There are no (further) constraints on this element Element idLibrary.parameter Short descriptionParameters defined by the library DefinitionThe parameter element defines parameters used by the library.
Data typeParameterDefinition ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A (to add?)
|
| dataRequirement | | 0..* | DataRequirement | There are no (further) constraints on this element Element idLibrary.dataRequirement Short descriptionWhat data is referenced by this library DefinitionDescribes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
Data typeDataRequirement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A (to add?)
|
| content | O Σ C | 1..1 | Attachment | Element idLibrary.content Short descriptionContents of the library, either embedded or referenced DefinitionThe 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.
CommentsWhen providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
Data typeAttachment ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - att-1: If the Attachment has data, it SHALL have a contentType
data.empty() or contentType.exists() Mappings- rim: n/a
- v2: ED/RP
- rim: ED
- rim: .text
Obligations| Actor | Code |
|---|
| http://ontariohealth.ca/fhir/eforms/ActorDefinition/qr-narrative-generator | SHALL:process |
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idLibrary.content.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idLibrary.content.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| contentType | Σ | 1..1 | codeBindingPattern | Element idLibrary.content.contentType Short descriptionMime type of the content, with charset etc. DefinitionIdentifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
RequirementsProcessors of the data need to be able to know how to interpret the data.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typecode BindingThe mime type of an attachment. Any valid mime type is allowed. Mime Types (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Patterntext/html Examples Generaltext/plain; charset=UTF-8, image/png Mappings- rim: n/a
- v2: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
- rim: ./mediaType, ./charset
|
| language | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idLibrary.content.language Short descriptionHuman language of the content (BCP-47) DefinitionThe human language of the content. The value can be any valid value according to BCP 47.
RequirementsUsers need to be able to choose between the languages in a set of attachments.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typecode BindingA human language. CommonLanguages (preferred) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples Generalen-AU Mappings |
| data | O | 1..1 | base64Binary | Element idLibrary.content.data Short descriptionData inline, base64ed DefinitionThe actual data of the attachment - a sequence of bytes, base64 encoded.
RequirementsThe data needs to able to be transmitted inline.
CommentsThe base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Data typebase64Binary ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: ED.5
- rim: ./data
Obligations| Actor | Code |
|---|
| http://ontariohealth.ca/fhir/eforms/ActorDefinition/qr-narrative-generator | SHALL:process |
|
| url | Σ | 0..1 | url | There are no (further) constraints on this element Element idLibrary.content.url Short descriptionUri where the data can be found DefinitionA location where the data can be accessed.
RequirementsThe data needs to be transmitted by reference.
CommentsIf both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
Data typeurl ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples Generalhttp://www.acme.com/logo-small.png Mappings- rim: n/a
- v2: RP.1+RP.2 - if they refer to a URL (see v2.6)
- rim: ./reference/literal
|
| size | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idLibrary.content.size Short descriptionNumber of bytes of content (if url provided) DefinitionThe number of bytes of data that make up this attachment (before base64 encoding, if that is done).
RequirementsRepresenting the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
CommentsThe number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
Data typeunsignedInt ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A (needs data type R3 proposal)
|
| hash | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element idLibrary.content.hash Short descriptionHash of the data (sha-1, base64ed) DefinitionThe calculated hash of the data using SHA-1. Represented using base64.
RequirementsIncluded so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
CommentsThe hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.
Data typebase64Binary ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
|
| title | Σ | 0..1 | string | There are no (further) constraints on this element Element idLibrary.content.title Short descriptionLabel to display in place of the data DefinitionA label or set of text to display in place of the data.
RequirementsApplications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples GeneralOfficial Corporate Logo Mappings- rim: n/a
- rim: ./title/data
|
| creation | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idLibrary.content.creation Short descriptionDate attachment was first created DefinitionThe date that the attachment was first created.
RequirementsThis is often tracked as an integrity issue for use of the attachment.
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A (needs data type R3 proposal)
|