Publish Box goes here
Definitions for the StructureDefinition-Composition-uv-ips Profile.
1. Composition | |
Definition | International Patient Summary composition. A composition is a set of healthcare-related information that is assembled together into a single logical document 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. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained. |
Control | 0..* |
Must Support | true |
Comments | 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. |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
2. Composition.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Must Support | true |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
3. Composition.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Must Support | true |
4. Composition.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
5. Composition.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable Max Binding: All Languages |
Type | code |
Comments | 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). |
6. Composition.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Must Support | true |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
7. Composition.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | 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. |
8. Composition.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
9. Composition.extension:healthcareProviderParticipant | |
Definition | Extension defined to allow to capture the preferred practitioner ( with its role ) or the organization to be contacted, represented in the IPS CDA with an indirect participant in the header. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Participant_uv_ips) (Extension Type: Reference(PractitionerRole | Organization)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
10. Composition.modifierExtension | |
Definition | 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | 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. |
11. Composition.identifier | |
Definition | Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Must Support | true |
Comments | See discussion in resource definition for how these relate. |
12. Composition.status | |
Definition | The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. |
Control | 1..1 |
Binding | The workflow/clinical status of the composition. The codes SHALL be taken from CompositionStatus |
Type | code |
Is Modifier | true |
Must Support | true |
Requirements | Need to be able to mark interim, amended, or withdrawn compositions or documents. |
Comments | 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. |
13. Composition.type | |
Definition | Specifies that this composition refer to a Patient Summary (Loinc "60591-5") |
Control | 1..1 |
Binding | Type of a composition. The codes SHOULD be taken from FHIR Document Type Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Key metadata element describing the composition, used in searching/filtering. |
Comments | 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. |
14. Composition.type.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
15. Composition.type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
16. Composition.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..* This element is affected by the following invariants: ele-1 |
Type | Coding(CodingIPS) |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
17. Composition.type.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
18. Composition.type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
19. Composition.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Fixed Value | http://loinc.org |
20. Composition.type.coding.version | |
Definition | 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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Must Support | true |
Comments | 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. |
21. Composition.type.coding.code | |
Definition | 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). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 60591-5 |
22. Composition.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
23. Composition.type.coding.display.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
24. Composition.type.coding.display.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
25. Composition.type.coding.display.extension:translation | |
Definition | Language translation from base language of resource to another language. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Translation) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
26. Composition.type.coding.display.value | |
Definition | The actual value |
Control | 0..1 |
Max Length | 1048576 |
27. Composition.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | 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. |
Comments | 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. |
28. Composition.type.text | |
Definition | 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. |
Control | 0..1 |
Type | string |
Requirements | 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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
29. Composition.class | |
Definition | 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. |
Control | 0..1 |
Binding | High-level kind of a clinical document at a macro level. For example codes, see FHIR Document Class Codes |
Type | CodeableConcept |
Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. |
Comments | This is a metadata field from XDS/MHD. |
30. Composition.subject | |
Definition | Who or what the composition is about. In general a 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). For the IPS the subject is always the patient. |
Control | 1..1 |
Type | Reference(Patient_uv_ips) |
Must Support | true |
Requirements | Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about. |
Comments | For clinical documents, this is usually the patient. |
31. Composition.subject.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
32. Composition.subject.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
33. Composition.subject.reference | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
Comments | 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. |
34. Composition.subject.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | 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. |
35. Composition.subject.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | 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. |
36. Composition.encounter | |
Definition | Describes the clinical encounter or type of care this documentation is associated with. |
Control | 0..1 |
Type | Reference(Encounter-uv-trillium2) |
Must Support | true |
Requirements | Provides context for the composition and supports searching. |
37. Composition.encounter.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
38. Composition.encounter.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
39. Composition.encounter.reference | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
Comments | 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. |
40. Composition.encounter.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | 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. |
41. Composition.encounter.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | 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. |
42. Composition.date | |
Definition | The composition editing time, when the composition was last logically changed by the author. |
Control | 1..1 |
Type | dateTime |
Must Support | true |
Requirements | dateTime is used for tracking, organizing versions and searching. |
Comments | The Last Modified Date on the composition may be after the date of the document was attested without being changed. |
43. Composition.author | |
Definition | Identifies who is responsible for the information in the IPS, not necessarily who typed it in. The type of author(s) contribute to determine the "nature"of the Patient Summary: e.g. a "human-curated" IPS Vs. an "automatically generated" IPS. |
Control | 1..* |
Type | Reference(Practitioner | Device | Patient | RelatedPerson) |
Must Support | true |
Requirements | Identifies who is responsible for the content. |
44. Composition.author.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
45. Composition.author.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
46. Composition.author.reference | |
Definition | 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. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
Comments | 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. |
47. Composition.author.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | 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. |
48. Composition.author.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | 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. |
49. Composition.title | |
Definition | Official human-readable label for the composition. For this document should be "International Patient Summary" or any equivalent translation |
Control | 1..1 |
Type | string |
Must Support | true |
Comments | 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. |
50. Composition.confidentiality | |
Definition | The code specifying the level of confidentiality of the Composition. |
Control | 0..1 |
Binding | Codes specifying the level of confidentiality of the composition. The codes SHALL be taken from ConfidentialityClassification |
Type | code |
Is Modifier | true |
Must Support | true |
Comments | The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not. |
51. Composition.attester | |
Definition | A participant who has attested to the accuracy of the composition/document. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | Identifies responsibility for the accuracy of the composition content. |
Comments | Only list each attester once. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
52. Composition.attester.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
53. Composition.attester.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
54. Composition.attester.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
55. Composition.attester.mode | |
Definition | The type of attestation the authenticator offers. |
Control | 1..* |
Binding | The way in which a person authenticated a composition. The codes SHALL be taken from CompositionAttestationMode |
Type | code |
Must Support | true |
Requirements | Indicates the level of authority of the attestation. |
Comments | Use more than one code where a single attester has more than one mode (professional and legal are often paired). |
56. Composition.attester.time | |
Definition | When the composition was attested by the party. |
Control | 0..1 |
Type | dateTime |
Must Support | true |
Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). |
57. Composition.attester.party | |
Definition | Who attested the composition in the specified way. |
Control | 0..1 |
Type | Reference(Patient | Practitioner | Organization) |
Must Support | true |
Requirements | Identifies who has taken on the responsibility for accuracy of the composition content. |
58. Composition.attester.party.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
59. Composition.attester.party.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
60. Composition.attester.party.reference | |
Definition | 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. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
Comments | 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. |
61. Composition.attester.party.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | 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. |
62. Composition.attester.party.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | 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. |
63. Composition.custodian | |
Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. |
Control | 0..1 |
Type | Reference(Organization) |
Must Support | true |
Requirements | Identifies where to go to find the current version, where to report issues, etc. |
Comments | 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. |
64. Composition.custodian.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
65. Composition.custodian.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
66. Composition.custodian.reference | |
Definition | 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. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
Comments | 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. |
67. Composition.custodian.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | 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. |
68. Composition.custodian.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | 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. |
69. Composition.relatesTo | |
Definition | Relationships that this composition has with other compositions or documents that already exist. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Comments | A document is a version specific composition. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
70. Composition.relatesTo.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
71. Composition.relatesTo.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
72. Composition.relatesTo.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
73. Composition.relatesTo.code | |
Definition | The type of relationship that this composition has with anther composition or document. |
Control | 1..1 |
Binding | The type of relationship between documents. The codes SHALL be taken from DocumentRelationshipType |
Type | code |
Must Support | true |
Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. |
74. Composition.relatesTo.target[x] | |
Definition | The target composition/document of this relationship. |
Control | 1..1 |
Type | Choice of: Identifier, Reference(Composition | Composition_uv_ips) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
75. Composition.event | |
Definition | The main activity being described by a IPS is the provision of healthcare over a period of time. In the CDA representation of the IPS this is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. In the FHIR representation at lest one event should be used to record this information. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range). For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the start value should represent the date when the treatment relationship between the patient and the GP started; and the end value the date of the latest care event. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event. |
Comments | The event needs to be consistent with the type element, though can provide further information if desired. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
76. Composition.event.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
77. Composition.event.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
78. Composition.event.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
79. Composition.event.code | |
Definition | This list of codes 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 the procedure being documented is necessarily a "History and Physical" act. |
Control | 0..* |
Binding | This list of codes represents the main clinical acts being documented. For example codes, see ActCode |
Type | CodeableConcept |
Comments | 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 eventCodes 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. |
80. Composition.event.period | |
Definition | 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. |
Control | 0..1 |
Type | Period |
81. Composition.event.detail | |
Definition | The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy. |
Control | 0..* |
Type | Reference(Resource) |
82. Composition.event:careProvisioningEvent | |
Definition | The provision of healthcare over a period of time this IPS is documenting. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event. |
Comments | The event needs to be consistent with the type element, though can provide further information if desired. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
83. Composition.event:careProvisioningEvent.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
84. Composition.event:careProvisioningEvent.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
85. Composition.event:careProvisioningEvent.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
86. Composition.event:careProvisioningEvent.code | |
Definition | This list of codes 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 the procedure being documented is necessarily a "History and Physical" act. |
Control | 1..* |
Binding | This list of codes represents the main clinical acts being documented. For example codes, see ActCode |
Type | CodeableConcept |
Must Support | true |
Comments | 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 eventCodes 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. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ActClass"/> <code value="PCPR"/> </coding> </valueCodeableConcept> |
87. Composition.event:careProvisioningEvent.period | |
Definition | 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. |
Control | 0..1 |
Type | Period |
Must Support | true |
88. Composition.event:careProvisioningEvent.detail | |
Definition | The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy. |
Control | 0..* |
Type | Reference(Resource) |
89. Composition.section | |
Definition | The root of the sections that make up the IPS composition. |
Control | 1..* |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
90. Composition.section.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
91. Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
92. Composition.section.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
93. Composition.section.title | |
Definition | 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. |
Control | 0..1 |
Type | string |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
94. Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 0..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | 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. |
95. Composition.section.text | |
Definition | 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. |
Control | 0..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
96. Composition.section.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
97. Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
98. Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
99. Composition.section.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
100. Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
101. Composition.section:sectionMedications | |
Definition | The medication summary section contains a description of the patient's medications relevant for the scope of the patient summary. The actual content could depend on the jurisdiction, it could report: - the currently active medications; - the current and past medications considered relevant by the authoring GP; - the patient prescriptions or dispensations automatically extracted by a regional or a national EHR. In all those cases however medications are documented in the Patient Summary as medication statements. This section requires either an entry indicating the subject is known not to be on any relevant medication; either an entry indicating that no information is available about medications; or entries summarizing the subject's relevant medications. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
102. Composition.section:sectionMedications.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
103. Composition.section:sectionMedications.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
104. Composition.section:sectionMedications.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
105. Composition.section:sectionMedications.title | |
Definition | 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. Medication Summary |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
106. Composition.section:sectionMedications.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="10160-0"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
107. Composition.section:sectionMedications.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
108. Composition.section:sectionMedications.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
109. Composition.section:sectionMedications.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
110. Composition.section:sectionMedications.entry | |
Definition | This list the medications relevant for the scope of the patient summary or it is used to indicate that the subject is known not to be on any relevant medication; either that no information is available about medications. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
111. Composition.section:sectionMedications.entry:medicationStatement | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(MedicationStatement_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
112. Composition.section:sectionMedications.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
113. Composition.section:sectionMedications.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionMedications |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
114. Composition.section:sectionAllergies | |
Definition | This section documents the relevant allergies or intolerances (conditions) for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. If no information about allergies is available, or if no allergies are known this should be clearly documented in the section. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
115. Composition.section:sectionAllergies.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
116. Composition.section:sectionAllergies.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
117. Composition.section:sectionAllergies.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
118. Composition.section:sectionAllergies.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
119. Composition.section:sectionAllergies.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="48765-2"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
120. Composition.section:sectionAllergies.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
121. Composition.section:sectionAllergies.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
122. Composition.section:sectionAllergies.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
123. Composition.section:sectionAllergies.entry | |
Definition | It lists the relevant allergies or intolerances (conditions) for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. This entry shall be used to document that no information about allergies is available, or that no allergies are known . |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
124. Composition.section:sectionAllergies.entry:allergyOrIntolerance | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(AllergyIntolerance_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
125. Composition.section:sectionAllergies.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
126. Composition.section:sectionAllergies.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionAllergies |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
127. Composition.section:sectionProblems | |
Definition | The IPS problem section lists and describes clinical problems or conditions currently being monitored for the patient. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
128. Composition.section:sectionProblems.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
129. Composition.section:sectionProblems.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
130. Composition.section:sectionProblems.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
131. Composition.section:sectionProblems.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
132. Composition.section:sectionProblems.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="11450-4"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
133. Composition.section:sectionProblems.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
134. Composition.section:sectionProblems.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
135. Composition.section:sectionProblems.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
136. Composition.section:sectionProblems.entry | |
Definition | It lists and describes clinical problems or conditions currently being monitored for the patient. This entry shall be used to document that no information about problems is available, or that no relevant problems are known. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
137. Composition.section:sectionProblems.entry:problem | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Condition_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
138. Composition.section:sectionProblems.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
139. Composition.section:sectionProblems.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionProblems |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
140. Composition.section:sectionProceduresHx | |
Definition | The History of Procedures Section contains a description of the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to: 1. Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section) 2. Therapeutic procedure: e.g. dialysis; 3. Surgical procedure: e.g. appendectomy |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
141. Composition.section:sectionProceduresHx.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
142. Composition.section:sectionProceduresHx.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
143. Composition.section:sectionProceduresHx.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
144. Composition.section:sectionProceduresHx.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
145. Composition.section:sectionProceduresHx.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="47519-4"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
146. Composition.section:sectionProceduresHx.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
147. Composition.section:sectionProceduresHx.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
148. Composition.section:sectionProceduresHx.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
149. Composition.section:sectionProceduresHx.entry | |
Definition | It lists the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to: 1. Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section) 2. Therapeutic procedure: e.g. dialysis; 3. Surgical procedure: e.g. appendectomy. This entry shall be used to document that no information about past procedures is available, or that no relevant past procedures are known. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
150. Composition.section:sectionProceduresHx.entry:procedure | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Procedure_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
151. Composition.section:sectionProceduresHx.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
152. Composition.section:sectionProceduresHx.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionProceduresHx |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
153. Composition.section:sectionImmunizations | |
Definition | The Immunizations Section defines a patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. The section includes current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
154. Composition.section:sectionImmunizations.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
155. Composition.section:sectionImmunizations.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
156. Composition.section:sectionImmunizations.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
157. Composition.section:sectionImmunizations.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
158. Composition.section:sectionImmunizations.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="11369-6"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
159. Composition.section:sectionImmunizations.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
160. Composition.section:sectionImmunizations.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
161. Composition.section:sectionImmunizations.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
162. Composition.section:sectionImmunizations.entry | |
Definition | It defines the patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. It may contain the entire immunization history that is relevant to the period of time being summarized. This entry shall be used to document that no information about immunizations is available, or that no immunizations are known. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
163. Composition.section:sectionImmunizations.entry:immunization | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Immunization-uv-ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
164. Composition.section:sectionImmunizations.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
165. Composition.section:sectionImmunizations.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionImmunizations |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
166. Composition.section:sectionMedicalDevices | |
Definition | The medical devices section contains narrative text and coded entries describing the patient history of medical device use. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
167. Composition.section:sectionMedicalDevices.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
168. Composition.section:sectionMedicalDevices.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
169. Composition.section:sectionMedicalDevices.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
170. Composition.section:sectionMedicalDevices.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
171. Composition.section:sectionMedicalDevices.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="46264-8"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
172. Composition.section:sectionMedicalDevices.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
173. Composition.section:sectionMedicalDevices.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
174. Composition.section:sectionMedicalDevices.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
175. Composition.section:sectionMedicalDevices.entry | |
Definition | It describes the patient history of medical device use. This entry shall be used to document that no information about medical device use is available, or that no relevant medical device use is known. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
176. Composition.section:sectionMedicalDevices.entry:deviceStatement | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(DeviceUseStatement_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
177. Composition.section:sectionMedicalDevices.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
178. Composition.section:sectionMedicalDevices.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionMedicalDevices |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
179. Composition.section:sectionResults | |
Definition | This section assembles relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
180. Composition.section:sectionResults.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
181. Composition.section:sectionResults.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
182. Composition.section:sectionResults.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
183. Composition.section:sectionResults.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
184. Composition.section:sectionResults.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="30954-2"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
185. Composition.section:sectionResults.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
186. Composition.section:sectionResults.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
187. Composition.section:sectionResults.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
188. Composition.section:sectionResults.entry | |
Definition | Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
189. Composition.section:sectionResults.entry:genericResult | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Observation_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
190. Composition.section:sectionResults.entry:laboratoryResult | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Observation_laboratory_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
191. Composition.section:sectionResults.entry:imagingResult | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Observation_imaging_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
192. Composition.section:sectionResults.entry:pathologyResult | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Observation_pathology_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
193. Composition.section:sectionResults.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
194. Composition.section:sectionResults.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionResults |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
195. Composition.section | |
Definition | The Vital signs section includes blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
196. Composition.section.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
197. Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
198. Composition.section.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
199. Composition.section.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
200. Composition.section.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="8716-3"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
201. Composition.section.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
202. Composition.section.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
203. Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
204. Composition.section.entry | |
Definition | Notable vital signs or physical findings as: blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
205. Composition.section.entry:vitalSign | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Vital Signs Profile) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
206. Composition.section.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
207. Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
208. Composition.section:sectionPastIllnessHx | |
Definition | The History of Past Illness section contains a description of the conditions the patient suffered in the past. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
209. Composition.section:sectionPastIllnessHx.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
210. Composition.section:sectionPastIllnessHx.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
211. Composition.section:sectionPastIllnessHx.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
212. Composition.section:sectionPastIllnessHx.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
213. Composition.section:sectionPastIllnessHx.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="11348-0"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
214. Composition.section:sectionPastIllnessHx.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
215. Composition.section:sectionPastIllnessHx.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
216. Composition.section:sectionPastIllnessHx.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
217. Composition.section:sectionPastIllnessHx.entry | |
Definition | It contains a description of the conditions the patient suffered in the past. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
218. Composition.section:sectionPastIllnessHx.entry:pastProblem | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Condition_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
219. Composition.section:sectionPastIllnessHx.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
220. Composition.section:sectionPastIllnessHx.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionPastIllnessHx |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
221. Composition.section:sectionFunctionalStatus | |
Definition | The functional status section shall contain a narrative description of capability of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
222. Composition.section:sectionFunctionalStatus.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
223. Composition.section:sectionFunctionalStatus.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
224. Composition.section:sectionFunctionalStatus.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
225. Composition.section:sectionFunctionalStatus.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
226. Composition.section:sectionFunctionalStatus.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="47420-5"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
227. Composition.section:sectionFunctionalStatus.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
228. Composition.section:sectionFunctionalStatus.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
229. Composition.section:sectionFunctionalStatus.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
230. Composition.section:sectionFunctionalStatus.entry | |
Definition | It describes capabilities of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
231. Composition.section:sectionFunctionalStatus.entry:disability | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Condition_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
232. Composition.section:sectionFunctionalStatus.entry:functionalAssessment | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(ClinicalImpression) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
233. Composition.section:sectionFunctionalStatus.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
234. Composition.section:sectionFunctionalStatus.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionFunctionalStatus |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
235. Composition.section:sectionPlanOfCare | |
Definition | The plan of care section contains a narrative description of the expectations for care including proposals, goals, and order requests for monitoring, tracking, or improving the condition of the patient. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
236. Composition.section:sectionPlanOfCare.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
237. Composition.section:sectionPlanOfCare.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
238. Composition.section:sectionPlanOfCare.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
239. Composition.section:sectionPlanOfCare.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
240. Composition.section:sectionPlanOfCare.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="18776-5"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
241. Composition.section:sectionPlanOfCare.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
242. Composition.section:sectionPlanOfCare.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
243. Composition.section:sectionPlanOfCare.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
244. Composition.section:sectionPlanOfCare.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
245. Composition.section:sectionPlanOfCare.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
246. Composition.section:sectionPlanOfCare.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionPlanOfCare |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
247. Composition.section:sectionSocialHistory | |
Definition | The social history section contains a description of the person’s Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.) |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
248. Composition.section:sectionSocialHistory.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
249. Composition.section:sectionSocialHistory.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
250. Composition.section:sectionSocialHistory.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
251. Composition.section:sectionSocialHistory.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
252. Composition.section:sectionSocialHistory.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="29762-2"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
253. Composition.section:sectionSocialHistory.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
254. Composition.section:sectionSocialHistory.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
255. Composition.section:sectionSocialHistory.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
256. Composition.section:sectionSocialHistory.entry | |
Definition | Description of the person’s Health related “lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.) |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
257. Composition.section:sectionSocialHistory.entry:smokingTobaccoUse | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
Type | Reference(Observation_tobaccoUse_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
258. Composition.section:sectionSocialHistory.entry:alcoholUse | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
Type | Reference(Observation_alcoholUse_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
259. Composition.section:sectionSocialHistory.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
260. Composition.section:sectionSocialHistory.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionSocialHistory |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
261. Composition.section:sectionPregnancyHx | |
Definition | The history of pregnancy section shall contain information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
262. Composition.section:sectionPregnancyHx.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
263. Composition.section:sectionPregnancyHx.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
264. Composition.section:sectionPregnancyHx.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
265. Composition.section:sectionPregnancyHx.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
266. Composition.section:sectionPregnancyHx.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="10162-6"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
267. Composition.section:sectionPregnancyHx.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
268. Composition.section:sectionPregnancyHx.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
269. Composition.section:sectionPregnancyHx.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
270. Composition.section:sectionPregnancyHx.entry | |
Definition | It contains information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
271. Composition.section:sectionPregnancyHx.entry:pregnancyStatus | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Observation_pregnancy_status_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
272. Composition.section:sectionPregnancyHx.entry:pregnancyOutcomeSummary | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Observation_pregnancy_outcome_uv_ips) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
273. Composition.section:sectionPregnancyHx.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
274. Composition.section:sectionPregnancyHx.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionPregnancyHx |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
275. Composition.section:sectionAdvanceDirectives | |
Definition | The advance directives section contains a narrative description of patient's advance directive. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
276. Composition.section:sectionAdvanceDirectives.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
277. Composition.section:sectionAdvanceDirectives.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
278. Composition.section:sectionAdvanceDirectives.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
279. Composition.section:sectionAdvanceDirectives.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
280. Composition.section:sectionAdvanceDirectives.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept(CodeableConceptIPS) |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="42348-3"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
281. Composition.section:sectionAdvanceDirectives.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
282. Composition.section:sectionAdvanceDirectives.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
283. Composition.section:sectionAdvanceDirectives.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
284. Composition.section:sectionAdvanceDirectives.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource | Consent) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
285. Composition.section:sectionAdvanceDirectives.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
286. Composition.section:sectionAdvanceDirectives.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionAdvanceDirectives |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
287. Composition.section:sectionEncounters | |
Definition | This section lists and describes any healthcare encounters pertinent to the patient’s current health status or historical health history. An encounter is an interaction, regardless of the setting, between a patient and a practitioner who is vested with primary responsibility for diagnosing, evaluating, or treating the patient’s condition. It may include visits, appointments, or non-face-to-face interactions. It is also a contact between a patient and a practitioner who has primary responsibility (exercising independent judgment) for assessing and treating the patient at a given contact.“ (from C-CDA specifications). |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
288. Composition.section:sectionEncounters.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
289. Composition.section:sectionEncounters.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
290. Composition.section:sectionEncounters.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
291. Composition.section:sectionEncounters.title | |
Definition | 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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Alternate Names | header, label, caption |
Comments | 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. |
292. Composition.section:sectionEncounters.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | 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. |
Fixed Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="46240-8"/> </coding> </valueCodeableConcept> |
293. Composition.section:sectionEncounters.text | |
Definition | 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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
294. Composition.section:sectionEncounters.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
295. Composition.section:sectionEncounters.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | 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. |
296. Composition.section:sectionEncounters.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
297. Composition.section:sectionEncounters.entry:encounterEntry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Encounter-uv-trillium2) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
298. Composition.section:sectionEncounters.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Control | 0..0 This element is affected by the following invariants: cmp-2 |
Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | 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. |
299. Composition.section:sectionEncounters.section | |
Definition | A nested sub-section within this section. |
Control | 0..0 This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sectionEncounters |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |