Generated Narrative: StructureDefinition awmf-guideline-record-s2e Name Flags Card. Type Description & Constraints Composition 0..* AWMFGuidelineRegistryRecord A set of resources composed into a single coherent clinical statement with clinical attestation #xD; Slices for category Content/Rules for all slices #xD; category:awmfGuidelineClass 0..1 CodeableConcept Categorization of Composition Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://fhir.awmf.org/awmf.ig/CodeSystem/cs-awmf-guideline-class #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: S2e #xD; display 1..1 string Representation defined by the system Fixed Value: Evidence-based Guideline #xD; Documentation for this format
AWMF S2e guideline based on systematic literature search and evaluation.
A set of resources composed into a single coherent clinical statement with clinical attestation
A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
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()
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
Authors with role “leading” or “contributing” SHALL reference an Organization.
author.where( extension( 'http://fhir.awmf.org/awmf.ig/StructureDefinition/ext-guideline-author-role' ).value.ofType(CodeableConcept).coding.where(code = 'leading' or code = 'contributing').exists() ).all(resolve().is(Organization))
If status = #registered, meta.tag[guideline-releaseType] SHALL be present and drawn from vs-guideline-release-type.
(status != 'registered') or (meta.tag.where(code.memberOf('http://fhir.awmf.org/awmf.ig/ValueSet/vs-guideline-release-type')).exists())
If status = #preliminary, extension[consultationPeriod] SHALL be present.
(status != 'preliminary') or (extension('http://fhir.awmf.org/awmf.ig/StructureDefinition/ext-consultation-period').value.exists())
If status = #registered, extension[plannedCompletionDate] SHALL be present.
(status != 'registered') or (extension('http://fhir.awmf.org/awmf.ig/StructureDefinition/ext-planned-completion-date').value.exists())
Exactly one author SHALL have the role “registrant”.
author.extension('http://fhir.awmf.org/awmf.ig/StructureDefinition/ext-guideline-author-role') .value.ofType(CodeableConcept).coding.where(code = 'registrant').count() = 1
No single author SHALL simultaneously have the roles “leading” and “contributing”.
author.all( extension('http://fhir.awmf.org/awmf.ig/StructureDefinition/ext-guideline-author-role') .value.ofType(CodeableConcept).coding.code .where($this = 'leading' or $this = 'contributing') .count() <= 1 /* each author may have 0 or 1 of those roles */ )
Every Guideline/Recommendation must have exactly one official identifier (with use = #official)
identifier.where(use='official').count() = 1
Entity, Role, or Act,Document[classCode="DOC" and moodCode="EVN" and isNormalAct()]
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
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())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
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 managable, 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.
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.
The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
When the resource last changed - e.g. when the version changed.
This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://build.fhir.org/http.html#read) interaction. There may be situations where the returned data elements might change *without* any change to the lastUpdated element. For example, if a server returns a code and its corresponding display by using a foreign-key reference to the code system, updates to the code system that affect the display name might not be reflected in the lastUpdated value of the resource holding the code. It is also possible that an underlying record might be updated in a way that isn't actually surfaced in the FHIR resource (e.g. changing non-exposed metadata) that would cause lastUpdated to change even when there is no apparent change in the data.
Identifies where the resource comes from
A uri that identifies the data source of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R5/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another server, document, message, database, etc. It can also refer to portions of a structure, such as a section, segment, row, etc.
The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R5/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R5/structuredefinition-definitions.html#StructureDefinition.url).
It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Security Labels from the Healthcare Privacy and Security Classification System.
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
The typ of registration of a new or updated guideline, i.e., whether it's an update, an upgrade, a completely new guideline, etc
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 its 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 its 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 a 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
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. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](http://build.fhir.org/resource.html#additional).
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.
Must have either extensions or value[x], not both
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).
A Boolean value to indicate that this artifact is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Natural language description of the artifact
A free text natural language description of the artifact from a consumer's perspective.
This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the artifact 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 artifact is presumed to be the predominant language in the place the artifact was created).
Explanation of why this artifact is needed and why it has been designed as it has.
This element does not describe the usage of the artifact. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this artifact.
A copyright statement relating to the artifact and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact.
The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It is expected to be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
The date on which the guideline was approved by the publisher.
The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
The date on which the guideline was last updated.
If specified, this date follows the original approval date.
Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
The period during which the guideline is intended to be in use.
The effective period for an artifact determines when the content is applicable for usage and is independent of publication and review dates. For example, an artifact intended to be used for the year 2016 might be published in 2015.
Allows establishing a transition before an artifact comes into effect and also allows for a sunsetting process when new versions of the artifact are or are expected to be used instead.
The start of the period. The boundary is inclusive.
If the low element is missing, the meaning is that the low boundary is not known.
End time with inclusive boundary, if not ongoing
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
If the end of the period is missing, it means that the period is ongoing
The Resource contains content in a language additional to the one in the language element.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a physical address, a telephone number, etc.
If no purpose is defined, then these contact details may be used for any purpose.
The purpose for which an extended contact detail should be used.
The name of an individual to contact, some types of contact detail are usually blank.
If there is no named individual, the telecom/address information is not generally monitored by a specific individual.
The contact details application for the purpose defined.
More than 1 address would be for different purposes, and thus should be entered as a different entry,.
This contact detail is handled/monitored by a specific organization
This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.
Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm).
Period that this contact was valid for usage
If the details have multiple periods, then enter in a new ExtendedContact with the new period.
The date on which the current version of the guideline was published.
The status of the processing for making the artifact publicly available, not necessarily the same as artifact status (Resource.status).
phone | fax | email | pager | url | sms | other
Telecommunications form for contact point - what communications system is required to make use of the contact.
Telecommunications form for contact point.
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Need to support legacy numbers that are not in a tightly controlled format.
home | work | temp | old | mobile - purpose of this contact point
Identifies the purpose for the contact point.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Specify preferred order of use (1 = highest)
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
Time period when the contact point was/is in use
The date on which the guideline was first published in its initial version.
The date on which this version of the guideline was submitted for publication.
The period during which the guideline is open for consultation.
The date on which the guideline is planned to be completed.
The date when the guideline registration was submitted.
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 managable, 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).
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://build.fhir.org/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this Composition, represented as a URI (globally unique)
An absolute URI that is used to identify this Composition 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 an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition 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.
Allows the Composition to be referenced by a single globally unique identifier.
An identifer in a (technical) system the guideline is represented in
A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.
The AWMF register number of the guideline, e.g., 001-001
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Identifier.system is always case sensitive. The FHIR specification, terminology.hl7.org and HL7 affiliates (for identifiers specific to their jurisdiction) define identifier systems that SHALL be used for certain types of identifiers. Specific rules can be found [here](http://hl7.org/fhir/R5/identifier-registry.html).
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
An explicitly assigned identifier of a variation of the content in the Composition
While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.
Version must be a major-minor version (e.g. 5.1)
Workflow status of the guideline from registration to publication or deprecation, e.g., preliminary, final, amendend etc.
Workflow status of the guideline from registration to publication or deprecation. Please note that the ValueSet 'http://hl7.org/fhir/ValueSet/composition-status' is required; We therefore created the ConceptMap 'FHIRStatusToAWMFStatus' to store the mapping to the AWMF status values.
If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements. Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.
Need to be able to mark interim, amended, or withdrawn compositions or documents.
This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
The workflow/clinical status of the composition.
interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.
Key metadata element describing the composition, used in searching/filtering.
A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.
High-level kind of a clinical document at a macro level.
.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
The guideline class for this guideline record: S1, S2k, S2e, S3
A reference to a code defined by a terminology system.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
The identification of the code system that defines the meaning of the symbol in the code.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Need to be unambiguous about the source of the definition of the symbol.
fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Need to refer to a particular code in the system.
fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
C*E.2 - but note this is not well followed
fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
If this coding was chosen directly by the user
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Plain text representation of the concept
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Very often the text is the same as a displayName of one of the codings.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Who and/or what the composition is about
Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
Reference a Citation Resource, ArtifactAssessment Resource (Classification Profile), Group Resource (EvidenceReportSubject Profile), ReserchStudy Resource, or any Resource to define a subject of this EvidenceReport.
Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.
Describes the clinical encounter or type of care this documentation is associated with.
Provides context for the composition and supports searching.
unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
Modification date of the Composition contents. Does not represent the publication, last review or approval date.
The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.
dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring this version of the Composition. When packaged in a document, [Bundle.timestamp](http://hl7.org/fhir/R5/bundle-definitions.html#Bundle.timestamp) is the date of packaging.
DocumentReference.content.attachment.date, DocumentReference.date
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 Composition instances.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Author, either as organization or person
The authors of the guildeline, either organizations or persons. Their respective role is defined by extension role: content-author, moderator etc.
Note that the authoring role defined here is disjunct with roles for the management of the guideline project as a whole (e.g., coordinatior, registrant etc). These are defined as dedicated contact points within the extension extendedContactDetail.
Identifies who is responsible for the content.
Describes the role of the author of the guideline.
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") - must be a resource in resources
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 known RESTful URL) or by resolving the target of the reference.
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). This element only allows for a single identifier. In the case where additional identifiers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
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.
Name for this Composition (computer friendly)
A natural language name identifying the {{title}}. 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.
For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.
DocumentReference.description, DocumentReference.content.attachment.title
A comment, general note or annotation not coded elsewhere.
The type of annotation. This extension can be used to map the v2 NTE-4 comment type field.
This is used to identify the type of annotation.
Individual responsible for the annotation
The individual responsible for making the annotation.
Organization is used when there's no need for specific attribution as to who made the comment.
Indicates when this particular annotation was made.
The annotation - text content (as markdown)
The text of the annotation in markdown format.
A remark to go with the publication of the guideline in the register, possibly changing over time based on updates to the guideline or similar circumstances
A participant who has attested to the accuracy of the composition/document.
Identifies responsibility for the accuracy of the composition content.
All FHIR elements must have a @value or children or both
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 managable, 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
reviewer | editor | endorser | informant | recorder
The type of attestation the authenticator offers.
Indicates the level of authority of the attestation.
implied by .authenticator/.legalAuthenticator
When the composition was attested by the party.
Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).
./time[type="TS" and isNormalDatatype()]
Who attested the composition in the specified way.
Identifies who has taken on the responsibility for accuracy of the composition content.
./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
Organization which maintains the composition
Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.
Identifies where to go to find the current version, where to report issues, etc.
.participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
Relationships to other compositions/documents
Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.
To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.\ When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource. Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier: ``` "relatesTo": [{ "type": "replaces", "targetReference": { "identifier": { "system": "...", "value": "..." } } }] ```
Additional classifiers for RelatedArtifacts
Provides additional classifiers of the related artifact.
A label to display with the reference to the related object, e.g. the title of a related guideline
This extension defines a label for the 'relatesTo' relationship using a CodeableConcept.
documentation | justification | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | specification-of | created-with | cite-as | summarizes
The type of relationship to the related artifact.
The artifact that is related to this Composition
The artifact that is related to this Composition Resource.
Additional classifiers for the related artifact.
A reference to a website this guideline (and accompanying informaiton) is being made available at
A reference to another (older, outdated or obsolete) guideline this guideline is replacing
A reference to another (newer, updated, merged) guideline this guideline has been replaced by
The clinical service(s) being documented
The clinical service, such as a colonoscopy or an appendectomy, being documented.
The event needs to be consistent with the type element, though can provide further information if desired.
Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.
The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
The event(s) being documented, as code(s), reference(s), or both
Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource.
An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more events are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.
This list of codes represents the main clinical acts being documented.
The root of the sections that make up the composition.
A section must contain at least one of text, entries, or sub-sections
text.exists() or entry.exists() or section.exists()
A section can only have an emptyReason if no entries are included
./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
A code identifying the kind of content contained within the section. This must be consistent with the section title.
The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Provides computable standardized labels to topics within the document.
Who and/or what authored the section, when the section is authored by someone other than the composition.author
Identifies who is responsible for the information in this section, not necessarily who typed it in. The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.
Who/what the section is about, when it is not about the subject of composition
The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
.subject? (CDA did not differentiate between subject and focus)
Text summary of the section, for human interpretation
A human-readable narrative that contains the attested content of the section, 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.
Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Specifies the order applied to the items in the section entries.
Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
What order applies to the items in the entry.
.outboundRelationship[typeCode=COMP].sequenceNumber > 1
A reference to data that supports this section
A reference to the actual resource from which the narrative in the section is derived.
If there are no entries in the list, an emptyReason SHOULD be provided.
.outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.
Allows capturing things like "none exist" or "not asked" which can be important for most lists.
A nested sub-section within this section.
Nested sections are primarily used to help human readers navigate to particular portions of the document.
Overview information regarding the guideline, to be shown in the register upon publication
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](extensibility.html#modifierExtension).
Classification of a section of a composition/document.
This is used where an item may repeat to indicate the language of each repeat.
Section Coding of a Composition providing a standardized way to categorize or identify the content of the section, enabling better organization, searchability, and interoperability of clinical documents or other structured artifacts.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://build.fhir.org/extensibility.html) for a list).
References to document attachements published with the guideline, e.g., a PDF long version of the guideline, a short version, an evidence report etc
Attachment type in DocumentReference must match the type of the section
entry[0].reference.resolve().ofType(DocumentReference).where(%context.code.coding.where(system = $this.system and code = $this.code).exists()).exists()