English Generated Narrative: StructureDefinition SGImplementationGuide Name Flags Card. Type Description & Constraints ImplementationGuide 1..1 CRMIShareableImplementationGuide A set of rules about how FHIR is used #xD; publisher 1..1 string Name of the publisher (organization or individual) #xD; license 0..1 code SPDX license code for this IG (or not-open-source) Required Pattern: CC-BY-SA-3.0-IGO #xD; definition #xD; Slices for resource 1..* BackboneElement Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() #xD; resource:ActivityDefinition 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ActivityDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: ActivityDefinition #xD; resource:CodeSystem 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines CodeSystem) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: CodeSystem #xD; resource:ConceptMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ConceptMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: ConceptMap #xD; resource:Extension 0..* BackboneElement Resource in the implementation guide #xD; resource:Library 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Library) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: Library #xD; resource:LogicalModel 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Logical Model) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition #xD; resource:Measure 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Measure) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: Measure #xD; resource:Profile 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition #xD; resource:Questionnaire 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Questionnaire) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: Questionnaire #xD; resource:StructureMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: StructureMap #xD; resource:ValueSet 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ValueSet) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: ValueSet #xD; Documentation for this format French Narratif généré : DéfinitionStructure SGImplementationGuide Nom Drapeaux Card. Type Description et contraintes ImplementationGuide 1..1 CRMIShareableImplementationGuide A set of rules about how FHIR is used #xD; publisher 1..1 string Name of the publisher (organization or individual) #xD; license 0..1 code SPDX license code for this IG (or not-open-source) Motif requis: CC-BY-SA-3.0-IGO #xD; definition #xD; Slices pour resource 1..* BackboneElement Resource in the implementation guide Slice: Non ordonné, Ouvert par profile:reference.resolve() #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:ActivityDefinition 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ActivityDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: ActivityDefinition #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:CodeSystem 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines CodeSystem) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: CodeSystem #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:ConceptMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ConceptMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: ConceptMap #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:Extension 0..* BackboneElement Resource in the implementation guide #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:Library 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Library) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: Library #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:LogicalModel 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Logical Model) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: StructureDefinition #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:Measure 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Measure) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: Measure #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:Profile 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: StructureDefinition #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:Questionnaire 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Questionnaire) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: Questionnaire #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:StructureMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: StructureMap #xD; Slices pour resource Contenu/Règles pour toutes les slices #xD; resource:ValueSet 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ValueSet) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Motif requis: ValueSet #xD; Documentation pour ce format Arabic السرد المُنشأ: StructureDefinition SGImplementationGuide الاسم الأعلام البطاقة. النوع الوصف والقيود ImplementationGuide 1..1 CRMIShareableImplementationGuide A set of rules about how FHIR is used #xD; publisher 1..1 string Name of the publisher (organization or individual) #xD; license 0..1 code SPDX license code for this IG (or not-open-source) النمط المطلوب: CC-BY-SA-3.0-IGO #xD; definition #xD; شرائح لـ resource 1..* BackboneElement Resource in the implementation guide شريحة: غير مرتبة، مفتوح بواسطة profile:reference.resolve() #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:ActivityDefinition 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ActivityDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: ActivityDefinition #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:CodeSystem 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines CodeSystem) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: CodeSystem #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:ConceptMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ConceptMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: ConceptMap #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:Extension 0..* BackboneElement Resource in the implementation guide #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:Library 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Library) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: Library #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:LogicalModel 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Logical Model) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: StructureDefinition #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:Measure 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Measure) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: Measure #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:Profile 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: StructureDefinition #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:Questionnaire 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Questionnaire) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: Questionnaire #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:StructureMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: StructureMap #xD; شرائح لـ resource المحتوى/القواعد لجميع الشرائح #xD; resource:ValueSet 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ValueSet) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") النمط المطلوب: ValueSet #xD; الوثائق الخاصة بهذا التنسيق Chinese Generated Narrative: 结构定义 SGImplementationGuide Name Flags Card. Type Description & Constraints ImplementationGuide 1..1 CRMIShareableImplementationGuide A set of rules about how FHIR is used #xD; publisher 1..1 string Name of the publisher (organization or individual) #xD; license 0..1 code SPDX license code for this IG (or not-open-source) Required Pattern: CC-BY-SA-3.0-IGO #xD; definition #xD; Slices for resource 1..* BackboneElement Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() #xD; Slices for resource Content/Rules for all slices #xD; resource:ActivityDefinition 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ActivityDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: ActivityDefinition #xD; Slices for resource Content/Rules for all slices #xD; resource:CodeSystem 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines CodeSystem) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: CodeSystem #xD; Slices for resource Content/Rules for all slices #xD; resource:ConceptMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ConceptMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: ConceptMap #xD; Slices for resource Content/Rules for all slices #xD; resource:Extension 0..* BackboneElement Resource in the implementation guide #xD; Slices for resource Content/Rules for all slices #xD; resource:Library 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Library) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: Library #xD; Slices for resource Content/Rules for all slices #xD; resource:LogicalModel 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Logical Model) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition #xD; Slices for resource Content/Rules for all slices #xD; resource:Measure 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Measure) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: Measure #xD; Slices for resource Content/Rules for all slices #xD; resource:Profile 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition #xD; Slices for resource Content/Rules for all slices #xD; resource:Questionnaire 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Questionnaire) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: Questionnaire #xD; Slices for resource Content/Rules for all slices #xD; resource:StructureMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: StructureMap #xD; Slices for resource Content/Rules for all slices #xD; resource:ValueSet 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ValueSet) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: ValueSet #xD; Documentation for this format Russian Сгенерированный нарратив: StructureDefinition SGImplementationGuide Наименование Флаги Карта. Тип Описание и ограничения ImplementationGuide 1..1 CRMIShareableImplementationGuide A set of rules about how FHIR is used #xD; publisher 1..1 string Name of the publisher (organization or individual) #xD; license 0..1 code SPDX license code for this IG (or not-open-source) Требуемый шаблон: CC-BY-SA-3.0-IGO #xD; definition #xD; Разрезы для resource 1..* BackboneElement Resource in the implementation guide Разрез: Не упорядочено, Открыто от profile:reference.resolve() #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:ActivityDefinition 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ActivityDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: ActivityDefinition #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:CodeSystem 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines CodeSystem) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: CodeSystem #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:ConceptMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ConceptMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: ConceptMap #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:Extension 0..* BackboneElement Resource in the implementation guide #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:Library 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Library) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: Library #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:LogicalModel 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Logical Model) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: StructureDefinition #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:Measure 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Measure) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: Measure #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:Profile 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: StructureDefinition #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:Questionnaire 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Questionnaire) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: Questionnaire #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:StructureMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: StructureMap #xD; Разрезы для resource Содержимое/правила для всех разрезов #xD; resource:ValueSet 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ValueSet) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Требуемый шаблон: ValueSet #xD; Документация для этого формата Spanish Generated Narrative: DefinicionDeEstructura SGImplementationGuide Name Flags Card. Type Description & Constraints ImplementationGuide 1..1 CRMIShareableImplementationGuide A set of rules about how FHIR is used #xD; publisher 1..1 string Name of the publisher (organization or individual) #xD; license 0..1 code SPDX license code for this IG (or not-open-source) Required Pattern: CC-BY-SA-3.0-IGO #xD; definition #xD; Slices for resource 1..* BackboneElement Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() #xD; Slices for resource Content/Rules for all slices #xD; resource:ActivityDefinition 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ActivityDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: ActivityDefinition #xD; Slices for resource Content/Rules for all slices #xD; resource:CodeSystem 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines CodeSystem) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: CodeSystem #xD; Slices for resource Content/Rules for all slices #xD; resource:ConceptMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ConceptMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: ConceptMap #xD; Slices for resource Content/Rules for all slices #xD; resource:Extension 0..* BackboneElement Resource in the implementation guide #xD; Slices for resource Content/Rules for all slices #xD; resource:Library 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Library) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: Library #xD; Slices for resource Content/Rules for all slices #xD; resource:LogicalModel 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Logical Model) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition #xD; Slices for resource Content/Rules for all slices #xD; resource:Measure 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Measure) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: Measure #xD; Slices for resource Content/Rules for all slices #xD; resource:Profile 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureDefinition) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition #xD; Slices for resource Content/Rules for all slices #xD; resource:Questionnaire 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines Questionnaire) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: Questionnaire #xD; Slices for resource Content/Rules for all slices #xD; resource:StructureMap 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines StructureMap) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: StructureMap #xD; Slices for resource Content/Rules for all slices #xD; resource:ValueSet 0..* BackboneElement Resource in the implementation guide #xD; reference 1..1 Reference(SMART Guidelines ValueSet) Location of the resource #xD; type 0..1 uri Type the reference refers to (e.g. "Patient") Required Pattern: ValueSet #xD; Documentation for this format
Defines the minimum expectations for ImplementationGuide resources used in SMART Guidelines
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Name should be usable as an identifier for the module by machine processing applications such as code generation
not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
If a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide
definition.resource.fhirVersion.all(%context.fhirVersion contains $this)
count(for $id in (f:resource/f:fhirVersion) return $id[not(ancestor::f:fhirVersion/@value=$id/@value)])=0
If knowledge capabilities are stated, they SHALL include shareable
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The 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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A 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.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. 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.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A 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.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
shareable | computable | publishable | executable
Defines a knowledge capability afforded by this knowledge artifact.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Indicates the mechanism used to compare versions to determine which is more current.
If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
Defines the versioning policy of the artifact.
Where a human readable web page describing the resource can be found, if it's at a different location to the canonical URL itself.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Modifier 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this implementation guide, represented as a URI (globally unique)
An absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.
Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. 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](http://hl7.org/fhir/R4/resource.html#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](http://hl7.org/fhir/R4/resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the implementation guide to be referenced by a single globally unique identifier. This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process.
Business version of the implementation guide
The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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.
There may be different implementation guide 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 implementation guide with the format [url]|[version].
Name for this implementation guide (computer friendly)
A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
The 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.
Support human navigation and code generation.
Name for this implementation guide (human friendly)
A short, descriptive, user-friendly title for the implementation guide.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
The status of this implementation guide. Enables tracking the life-cycle of the content.
Allows filtering of implementation guides that are appropriate for use versus not.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide.
The date (and optionally time) when the implementation guide 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 implementation guide changes.
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the implementation guide. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Name of the publisher (organization or individual)
The name of the organization or individual that published the implementation guide.
Usually an organization but may be an individual. The publisher (or steward) of the implementation guide is the organization or individual primarily responsible for the maintenance and upkeep of the implementation guide. 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 implementation guide. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the implementation guide. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
Natural language description of the implementation guide
A free text natural language description of the implementation guide from a consumer's perspective.
This description can be used to capture details such as why the implementation guide 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 implementation guide 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 implementation guide is presumed to be the predominant language in the place the implementation guide was created).
The context that the content is intended to support
The 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 implementation guide instances.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for implementation guide (if applicable)
A legal or geographic region in which the implementation guide is intended to be used.
It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use.
A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content.
The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.
Many (if not all) IG publishing tools will require that this element be present. For implementation guides published through HL7 or the FHIR foundation, the FHIR product director assigns package IDs.
SPDX license code for this IG (or not-open-source)
The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.
The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/).
FHIR Version(s) this Implementation Guide targets
The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.
Most implementation guides target a single version - e.g. they describe how to use a particular version, and the profiles and examples etc are valid for that version. But some implementation guides describe how to use multiple different versions of FHIR to solve the same problem, or in concert with each other. Typically, the requirement to support multiple versions arises as implementation matures and different implementation communities are stuck at different versions by regulation or market dynamics.
Another Implementation guide this depends on
Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional content defined by implementations
May 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.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
A canonical reference to the Implementation guide for the dependency.
Usually, A canonical reference to the implementation guide is the same as the master location at which the implementation guide is published.
The NPM package name for the Implementation Guide that this IG depends on.
The version of the IG that is depended on, when the correct version is required to understand the IG correctly.
This follows the syntax of the NPM packaging version field - see reference.
A set of profiles that all resources covered by this implementation guide must conform to.
See [Default Profiles](http://hl7.org/fhir/R4/implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.
The type of resource that all instances must conform to.
The type must match that of the profile that is referred to but is made explicit here as a denormalization so that a system processing the implementation guide resource knows which resources the profile applies to even if the profile itself is not available.
One of the resource types defined as part of this version of FHIR.
Profile that all resources must conform to
A reference to the profile that all instances must conform to.
The information needed by an IG publisher tool to publish the whole implementation guide.
Principally, this consists of information abuot source resource and file locations, and build parameters and templates.
If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide
resource.groupingId.all(%context.grouping.id contains $this)
count(for $id in (f:resource/f:groupingId) return $id[not(ancestor::f:grouping/@id=$id/@value)])=0
Grouping used to present related resources in the IG
A logical group of resources. Logical groups can be used when building pages.
Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically.
The human-readable title to display for the package of resources when rendering the implementation guide.
Human readable text describing the package
A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.
Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.
Versions this applies to (if different to IG)
Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.
The resource SHALL be valid against all the versions it is specified to apply to. If the resource referred to is a StructureDefinition, the fhirVersion stated in the StructureDefinition cannot disagree with the version specified here; the specified versions SHALL include the version specified by the StructureDefinition, and may include additional versions using the [applicable-version](http://hl7.org/fhir/R4/extension-structuredefinition-applicable-version.html) extension.
A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).
A description of the reason that a resource has been included in the implementation guide.
This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).
Is an example/What is this an example of?
If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.
Examples: * StructureDefinition -> Any * ValueSet -> expansion * OperationDefinition -> Parameters * Questionnaire -> QuestionnaireResponse.
Reference to the id of the grouping this resource appears in.
This must correspond to a package.id element within this implementation guide.
Extensions are always sliced by (at least) url
Literal reference, Relative, internal or absolute URL
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Type the reference refers to (e.g. "Patient")
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Aa resource (or, for logical models, the URI of the logical model).
Logical reference, when literal reference is not known
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
A page / section in the implementation guide. The root page is the implementation guide home page.
Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.
The publishing tool will autogenerate source for list (source = n/a) and inject included implementations for include (source = uri of guide to include).
Short title shown for navigational assistance
A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.
A code that indicates how the page is generated.
The implementation guide breadcrumbs are generated from this structure.
apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
Code of parameter that is input to the guide.
The scope in which the template applies.
Information about an assembled implementation guide, created by the publication tooling.
Location of rendered implementation guide
A pointer to official web page, PDF or other rendering of the implementation guide.
Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true.
The relative path for primary page for this resource within the IG.
Appending 'rendering' + "/" + this should resolve to the resource page.
Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.
Appending 'rendering' + "/" + this should resolve to the page.
Label for the page intended for human display.
Allows generation of labels for markdown-generated hyperlinks.
The name of an anchor available on the page.
Appending 'rendering' + "/" + page.name + "#" + page.anchor should resolve to the anchor.
Indicates a relative path to an image that exists within the IG.
Allows validation of image links from a derived IG to this IG without a local copy of the IG.
Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.
Allows validation of links from a derived IG to this IG without a local copy of the IG.