Guideline - Evidence Based Medicine on FHIR Implementation Guide v1.0.0-ballot

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional Bindings

Purpose

CommonLanguages

Starter Set

0..1

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

versionAlgorithm

0..1

How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-version profiled by http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm

experimental

0..1

For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental

description

0..1

Natural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description

purpose

0..1

Why this {{title}} is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose

0..1

Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright

0..1

0..1

When the resource was approved by publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-approvalDate

lastReviewDate

0..1

When the resource was last reviewed by the publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-lastReviewDate

effectivePeriod

0..1

When the resource is expected to be used
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-effectivePeriod

?!Σ

0..*

Extensions that cannot be ignored

url

0..1

Canonical identifier for this Composition, represented as a URI (globally unique)

identifier

0..*

Identifier

Version-independent identifier for the Composition

0..1

An explicitly assigned identifer of a variation of the content in the Composition

status

?!Σ

1..1

type

1..1

Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: EvidenceReport

1..1

Representation defined by the system
Fixed Value: EvidenceReport

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

Slices for category

1..*

Categorization of Composition
Slice: Unordered, Open by value:coding
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.

category:guideline

SΣ

1..1

Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: Guideline

1..1

Representation defined by the system
Fixed Value: Guideline

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

subject

0..1

Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy)

Who and/or what the composition is about

encounter

0..1

Reference(Encounter)

Context of the Composition

1..1

Composition editing time

useContext

0..*

UsageContext

The context that the content is intended to support

1..*

Who and/or what authored the composition

name

0..1

Name for this Composition (computer friendly)

1..1

Human Readable name/title

note

0..*

Annotation

For any additional notes

attester

0..*

Attests to accuracy of composition

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

mode

1..1

reviewer | editor | endorser | informant
Binding: ContributorRole (preferred)

time

0..1

When the composition was attested

party

0..1

Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)

Who attested the composition

custodian

0..1

Reference(Organization)

Organization which maintains the composition

relatesTo

0..*

RelatedArtifact

Relationships to other compositions/documents

event

0..*

The clinical service(s) being documented

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

period

0..1

CodeableReference(Resource)

The period covered by the documentation

detail

0..*

The event(s) being documented, as code(s), reference(s), or both
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.

Slices for section

1..6

Composition is broken into sections
Slice: Unordered, Closed by value:code.coding
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

section:All Slices

Content/Rules for all slices

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:introduction

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: introduction

1..1

Representation defined by the system
Fixed Value: Introduction

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:recommendations

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: recommendations

1..1

Representation defined by the system
Fixed Value: Recommendations

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

Reference(Recommendation)

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:text

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: text

1..1

Representation defined by the system
Fixed Value: Text

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:methods

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: methods

1..1

Representation defined by the system
Fixed Value: Methods

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:acknowledgements

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: acknowledgements

1..1

Representation defined by the system
Fixed Value: Acknowledgements

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:appendices

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: appendices

1..1

Representation defined by the system
Fixed Value: Appendices

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Documentation for this format

Nested Section

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.language	required	AllLanguages `http://hl7.org/fhir/ValueSet/all-languages\|5.0.0` from the FHIR Standard
Composition.status	required	CompositionStatus `http://hl7.org/fhir/ValueSet/composition-status\|5.0.0` from the FHIR Standard
Composition.type	preferred	FHIRDocumentTypeCodes `http://hl7.org/fhir/ValueSet/doc-typecodes` from the FHIR Standard
Composition.category	example	ReferencedItemCategoryValueSet `http://hl7.org/fhir/ValueSet/referenced-item-category` from the FHIR Standard
Composition.category:guideline	example	ReferencedItemCategoryValueSet `http://hl7.org/fhir/ValueSet/referenced-item-category` from the FHIR Standard
Composition.attester.mode	preferred	ContributorRole `http://hl7.org/fhir/ValueSet/contributor-role` from the FHIR Standard
Composition.event.detail	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Composition.section.code	extensible	EvidenceReportSectionCode_Value_Set `https://fevir.net/resources/ValueSet/179431` from this IG
Composition.section.orderedBy	preferred	ListOrderCodes `http://hl7.org/fhir/ValueSet/list-order` from the FHIR Standard
Composition.section.emptyReason	preferred	ListEmptyReasons `http://hl7.org/fhir/ValueSet/list-empty-reason` from the FHIR Standard
Composition.section:introduction.code	extensible	EvidenceReportSectionCode_Value_Set `https://fevir.net/resources/ValueSet/179431` from this IG
Composition.section:introduction.orderedBy	preferred	ListOrderCodes `http://hl7.org/fhir/ValueSet/list-order` from the FHIR Standard
Composition.section:introduction.emptyReason	preferred	ListEmptyReasons `http://hl7.org/fhir/ValueSet/list-empty-reason` from the FHIR Standard
Composition.section:recommendations.code	extensible	EvidenceReportSectionCode_Value_Set `https://fevir.net/resources/ValueSet/179431` from this IG
Composition.section:recommendations.orderedBy	preferred	ListOrderCodes `http://hl7.org/fhir/ValueSet/list-order` from the FHIR Standard
Composition.section:recommendations.emptyReason	preferred	ListEmptyReasons `http://hl7.org/fhir/ValueSet/list-empty-reason` from the FHIR Standard
Composition.section:text.code	extensible	EvidenceReportSectionCode_Value_Set `https://fevir.net/resources/ValueSet/179431` from this IG
Composition.section:text.orderedBy	preferred	ListOrderCodes `http://hl7.org/fhir/ValueSet/list-order` from the FHIR Standard
Composition.section:text.emptyReason	preferred	ListEmptyReasons `http://hl7.org/fhir/ValueSet/list-empty-reason` from the FHIR Standard
Composition.section:methods.code	extensible	EvidenceReportSectionCode_Value_Set `https://fevir.net/resources/ValueSet/179431` from this IG
Composition.section:methods.orderedBy	preferred	ListOrderCodes `http://hl7.org/fhir/ValueSet/list-order` from the FHIR Standard
Composition.section:methods.emptyReason	preferred	ListEmptyReasons `http://hl7.org/fhir/ValueSet/list-empty-reason` from the FHIR Standard
Composition.section:acknowledgements.code	extensible	EvidenceReportSectionCode_Value_Set `https://fevir.net/resources/ValueSet/179431` from this IG
Composition.section:acknowledgements.orderedBy	preferred	ListOrderCodes `http://hl7.org/fhir/ValueSet/list-order` from the FHIR Standard
Composition.section:acknowledgements.emptyReason	preferred	ListEmptyReasons `http://hl7.org/fhir/ValueSet/list-empty-reason` from the FHIR Standard
Composition.section:appendices.code	extensible	EvidenceReportSectionCode_Value_Set `https://fevir.net/resources/ValueSet/179431` from this IG
Composition.section:appendices.orderedBy	preferred	ListOrderCodes `http://hl7.org/fhir/ValueSet/list-order` from the FHIR Standard
Composition.section:appendices.emptyReason	preferred	ListEmptyReasons `http://hl7.org/fhir/ValueSet/list-empty-reason` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmp-1	error	Composition.section, Composition.section:introduction, Composition.section:recommendations, Composition.section:text, Composition.section:methods, Composition.section:acknowledgements, Composition.section:appendices	A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists()
cmp-2	error	Composition.section, Composition.section:introduction, Composition.section:recommendations, Composition.section:text, Composition.section:methods, Composition.section:acknowledgements, Composition.section:appendices	A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
dom-2	error	Composition	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Composition	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().ofType(canonical) \| %resource.descendants().ofType(uri) \| %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Composition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Composition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Composition	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from EvidenceReport

Summary

Mandatory: 4 elements(6 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Recommendation (http://hl7.org/fhir/uv/ebm/StructureDefinition/recommendation)

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Composition.category
The element 1 is sliced based on the value of Composition.section (Closed)

Maturity: 1

Differential View

This structure is derived from EvidenceReport

Name	Flags	Card.	Type	Description & Constraints
Composition		0..*	EvidenceReport	A set of resources composed into a single coherent clinical statement with clinical attestation
Slices for category		1..*	CodeableConcept	Categorization of Composition Slice: Unordered, Open by value:coding
category:guideline	S	1..1	CodeableConcept	Categorization of Composition
coding		1..1	Coding	Code defined by a terminology system Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423
code		1..1	code	Symbol in syntax defined by the system Fixed Value: Guideline
display		1..1	string	Representation defined by the system Fixed Value: Guideline
Slices for section		1..6	BackboneElement	Composition is broken into sections Slice: Unordered, Closed by value:code.coding
section:introduction	S	0..1	BackboneElement	Composition is broken into sections
code
coding		1..1	Coding	Code defined by a terminology system Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423
code		1..1	code	Symbol in syntax defined by the system Fixed Value: introduction
display		1..1	string	Representation defined by the system Fixed Value: Introduction
section:recommendations	S	0..1	BackboneElement	Composition is broken into sections
code
coding		1..1	Coding	Code defined by a terminology system Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423
code		1..1	code	Symbol in syntax defined by the system Fixed Value: recommendations
display		1..1	string	Representation defined by the system Fixed Value: Recommendations
entry		0..*	Reference(Recommendation)	A reference to data that supports this section
section:text	S	0..1	BackboneElement	Composition is broken into sections
code
coding		1..1	Coding	Code defined by a terminology system Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423
code		1..1	code	Symbol in syntax defined by the system Fixed Value: text
display		1..1	string	Representation defined by the system Fixed Value: Text
section:methods	S	0..1	BackboneElement	Composition is broken into sections
code
coding		1..1	Coding	Code defined by a terminology system Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423
code		1..1	code	Symbol in syntax defined by the system Fixed Value: methods
display		1..1	string	Representation defined by the system Fixed Value: Methods
section:acknowledgements	S	0..1	BackboneElement	Composition is broken into sections
code
coding		1..1	Coding	Code defined by a terminology system Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423
code		1..1	code	Symbol in syntax defined by the system Fixed Value: acknowledgements
display		1..1	string	Representation defined by the system Fixed Value: Acknowledgements
section:appendices	S	0..1	BackboneElement	Composition is broken into sections
code
coding		1..1	Coding	Code defined by a terminology system Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423
code		1..1	code	Symbol in syntax defined by the system Fixed Value: appendices
display		1..1	string	Representation defined by the system Fixed Value: Appendices
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Composition		0..*	EvidenceReport	A set of resources composed into a single coherent clinical statement with clinical attestation
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
versionAlgorithm		0..1	string	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-version profiled by http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
experimental		0..1	boolean	For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
description		0..1	markdown	Natural language description of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-description
purpose		0..1	markdown	Why this {{title}} is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
copyright		0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
copyrightLabel		0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
approvalDate		0..1	date	When the resource was approved by publisher URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-approvalDate
lastReviewDate		0..1	date	When the resource was last reviewed by the publisher URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-lastReviewDate
effectivePeriod		0..1	Period	When the resource is expected to be used URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-effectivePeriod
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	registered \| partial \| preliminary \| final \| amended \| corrected \| appended \| cancelled \| entered-in-error \| deprecated \| unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition.
type	Σ	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
coding	Σ	1..1	Coding	Code defined by a terminology system Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423
code		1..1	code	Symbol in syntax defined by the system Fixed Value: EvidenceReport
display		1..1	string	Representation defined by the system Fixed Value: EvidenceReport
Slices for category	Σ	1..*	CodeableConcept	Categorization of Composition Slice: Unordered, Open by value:coding Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.
category:guideline	SΣ	1..1	CodeableConcept	Categorization of Composition Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.
coding	Σ	1..1	Coding	Code defined by a terminology system Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423
code		1..1	code	Symbol in syntax defined by the system Fixed Value: Guideline
display		1..1	string	Representation defined by the system Fixed Value: Guideline
subject	Σ	0..1	Reference(Citation \| Classification \| EvidenceReportSubject \| ResearchStudy)	Who and/or what the composition is about
date	Σ	1..1	dateTime	Composition editing time
author	Σ	1..*	Reference(Practitioner \| PractitionerRole \| Device \| Patient \| RelatedPerson \| Organization)	Who and/or what authored the composition
title	Σ	1..1	string	Human Readable name/title
Slices for section	C	1..6	BackboneElement	Composition is broken into sections Slice: Unordered, Closed by value:code.coding cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
section:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
section:introduction	SC	0..1	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
section:recommendations	SC	0..1	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry	C	0..*	Reference(Recommendation)	A reference to data that supports this section
section:text	SC	0..1	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
section:methods	SC	0..1	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
section:acknowledgements	SC	0..1	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
section:appendices	SC	0..1	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.status	required	CompositionStatus `http://hl7.org/fhir/ValueSet/composition-status\|5.0.0` from the FHIR Standard
Composition.type	preferred	FHIRDocumentTypeCodes `http://hl7.org/fhir/ValueSet/doc-typecodes` from the FHIR Standard
Composition.category	example	ReferencedItemCategoryValueSet `http://hl7.org/fhir/ValueSet/referenced-item-category` from the FHIR Standard
Composition.category:guideline	example	ReferencedItemCategoryValueSet `http://hl7.org/fhir/ValueSet/referenced-item-category` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmp-1	error	Composition.section, Composition.section:introduction, Composition.section:recommendations, Composition.section:text, Composition.section:methods, Composition.section:acknowledgements, Composition.section:appendices	A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists()
cmp-2	error	Composition.section, Composition.section:introduction, Composition.section:recommendations, Composition.section:text, Composition.section:methods, Composition.section:acknowledgements, Composition.section:appendices	A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
dom-2	error	Composition	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Composition	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().ofType(canonical) \| %resource.descendants().ofType(uri) \| %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Composition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Composition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Composition	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Description & Constraints

Composition

0..*

EvidenceReport

A set of resources composed into a single coherent clinical statement with clinical attestation

0..1

Logical id of this artifact

Meta

Metadata about the resource

implicitRules

?!Σ

0..1

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional Bindings

Purpose

CommonLanguages

Starter Set

0..1

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

versionAlgorithm

0..1

How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-version profiled by http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm

experimental

0..1

For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental

description

0..1

Natural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description

purpose

0..1

Why this {{title}} is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose

0..1

Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright

0..1

0..1

When the resource was approved by publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-approvalDate

lastReviewDate

0..1

When the resource was last reviewed by the publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-lastReviewDate

effectivePeriod

0..1

When the resource is expected to be used
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-effectivePeriod

?!Σ

0..*

Extensions that cannot be ignored

url

0..1

Canonical identifier for this Composition, represented as a URI (globally unique)

identifier

0..*

Identifier

Version-independent identifier for the Composition

0..1

An explicitly assigned identifer of a variation of the content in the Composition

status

?!Σ

1..1

type

1..1

Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: EvidenceReport

1..1

Representation defined by the system
Fixed Value: EvidenceReport

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

Slices for category

1..*

Categorization of Composition
Slice: Unordered, Open by value:coding
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.

category:guideline

SΣ

1..1

Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: Guideline

1..1

Representation defined by the system
Fixed Value: Guideline

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

subject

0..1

Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy)

Who and/or what the composition is about

encounter

0..1

Reference(Encounter)

Context of the Composition

1..1

Composition editing time

useContext

0..*

UsageContext

The context that the content is intended to support

1..*

Who and/or what authored the composition

name

0..1

Name for this Composition (computer friendly)

1..1

Human Readable name/title

note

0..*

Annotation

For any additional notes

attester

0..*

Attests to accuracy of composition

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

mode

1..1

reviewer | editor | endorser | informant
Binding: ContributorRole (preferred)

time

0..1

When the composition was attested

party

0..1

Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)

Who attested the composition

custodian

0..1

Reference(Organization)

Organization which maintains the composition

relatesTo

0..*

RelatedArtifact

Relationships to other compositions/documents

event

0..*

The clinical service(s) being documented

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

period

0..1

CodeableReference(Resource)

The period covered by the documentation

detail

0..*

The event(s) being documented, as code(s), reference(s), or both
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.

Slices for section

1..6

section:All Slices

Content/Rules for all slices

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:introduction

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: introduction

1..1

Representation defined by the system
Fixed Value: Introduction

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:recommendations

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: recommendations

1..1

Representation defined by the system
Fixed Value: Recommendations

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

Reference(Recommendation)

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:text

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: text

1..1

Representation defined by the system
Fixed Value: Text

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:methods

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: methods

1..1

Representation defined by the system
Fixed Value: Methods

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:acknowledgements

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: acknowledgements

1..1

Representation defined by the system
Fixed Value: Acknowledgements

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*

Nested Section

section:appendices

0..1

Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Label for section (e.g. for ToC)

0..1

Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

Code defined by a terminology system

Required Pattern: At least the following

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: appendices

1..1

Representation defined by the system
Fixed Value: Appendices

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..*

Who and/or what authored the section

0..1

Who/what the section is about, when it is not about the subject of composition

0..1

Text summary of the section, for human interpretation

0..1

Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

0..*

A reference to data that supports this section

0..1

Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

0..*