This page is part of the Profiles for ICSR Transfusion and Vaccination Adverse Event Detection and Reporting (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the ibm-fda-icsr-composition resource profile.
1. Composition | |
Definition | A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). |
Control | 0..* |
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-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 or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
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 | string |
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 might not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. Composition.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages A human language. |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. Composition.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 |
Type | Narrative |
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 information is added later. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
8. Composition.extension | |
Definition | An Extension |
Control | 4..* |
Type | Extension |
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()) |
Slicing | This element introduces a set of slices on Composition.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
9. Composition.extension:firstReceiveDate | |
SliceName | firstReceiveDate |
Definition | The date when the report was first received from the source |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(FirstReceiveDate) (Extension Type: dateTime) |
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()) |
10. Composition.extension:mostRecentInfoDate | |
SliceName | mostRecentInfoDate |
Definition | The date of the most recent information for this report |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(MostRecentDate) (Extension Type: dateTime) |
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()) |
11. Composition.extension:additionalDocuments | |
SliceName | additionalDocuments |
Definition | A set of information to indicate what additional documentation exists. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AdditionalDocumentInformation) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta) |
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()) |
12. Composition.extension:expeditedReport | |
SliceName | expeditedReport |
Definition | Information on whether the ICSR report meets criteria of an expedited report |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ExpeditedReport) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta) |
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()) |
13. Composition.extension:otherCaseIdentifier | |
SliceName | otherCaseIdentifier |
Definition | Other identifiers used to identify the ICSR report |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(CaseIdentifier) (Extension Type: Identifier) |
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()) |
14. Composition.extension:firstSenderType | |
SliceName | firstSenderType |
Definition | Identifies the type of the first sender of the ICSR report |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(FirstSenderType) (Extension Type: CodeableConcept) |
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()) |
15. Composition.extension:previousCaseIdentifier | |
SliceName | previousCaseIdentifier |
Definition | Previous identifiers used to reference this case |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(PreviousCaseIdentifier) (Extension Type: Identifier) |
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()) |
16. Composition.extension:reportAmendment | |
SliceName | reportAmendment |
Definition | Information about report amendments that have been made |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ReportAmendment) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta) |
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()) |
17. Composition.extension:combinationProductReport | |
SliceName | combinationProductReport |
Definition | A flag to indicate whether the ICSR report is for a combination product |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(CombinationProductReport) (Extension Type: boolean) |
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()) |
18. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
19. Composition.identifier | |
Definition | A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
Must Support | true |
Comments | Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. Composition.identifier.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 |
21. Composition.identifier.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. |
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()) |
Slicing | This element introduces a set of slices on Composition.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
22. Composition.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. Composition.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 |
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Type | CodeableConcept |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. Composition.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 1..1 |
Type | uri |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Pattern Value | urn:oid:2.16.840.1.113883.3.989.2.1.3.1 |
Example | General:http://www.acme.com/identifiers/patient |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Composition.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | string |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Example | General:123456 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. Composition.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. Composition.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Reference(Organization) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. 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 codes SHALL be taken from CompositionStatus The workflow/clinical status of the composition. |
Type | code |
Is Modifier | 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. |
Pattern Value | final |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. Composition.type | |
Definition | Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. |
Control | 1..1 |
Binding | The codes SHOULD be taken from FHIRDocumentTypeCodes Type of a composition. |
Type | CodeableConcept |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="85893-6"/> <display value="Adverse event note"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. Composition.category | |
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 | 1..1 |
Binding | For example codes, see DocumentClassValueSet High-level kind of a clinical document at a macro level. |
Type | CodeableConcept |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. Composition.subject | |
Definition | Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). |
Control | 1..1 |
Type | Reference(ICSRPatient) |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. Composition.encounter | |
Definition | Describes the clinical encounter or type of care this documentation is associated with. |
Control | 0..1 |
Type | Reference(Encounter) |
Requirements | Provides context for the composition and supports searching. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. 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. Note that this is the time of authoring. When packaged in a document, Bundle.timestamp is the date of packaging. |
Comments | The Last Modified Date on the composition may be after the date of the document was attested without being changed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. Composition.author | |
Definition | Identifies who is responsible for the information in the composition, not necessarily who typed it in. |
Control | 1..1 |
Type | Reference(PractitionerRole | ICSRPatient | RelatedPerson) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. 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 |
36. Composition.author.extension | |
Definition | An Extension |
Control | 1..* |
Type | Extension |
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()) |
Slicing | This element introduces a set of slices on Composition.author.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
37. Composition.author.extension:primarySource | |
SliceName | primarySource |
Definition | Whether an author is the primary source of a composition |
Control | 1..1 |
Type | Extension(AuthorPrimarySource) (Extension Type: boolean) |
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()) |
38. 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
39. Composition.author.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Control | 0..1 |
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model). |
Type | uri |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
40. Composition.author.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
41. 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. Composition.title | |
Definition | Official human-readable label for the composition. |
Control | 1..1 |
Type | string |
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. |
Pattern Value | ICSR Submission |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
43. Composition.confidentiality | |
Definition | The code specifying the level of confidentiality of the Composition. |
Control | 0..1 |
Binding | The codes SHALL be taken from v3.ConfidentialityClassification (2014-03-26) Codes specifying the level of confidentiality of the composition. |
Type | code |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
44. Composition.attester | |
Definition | A participant who has attested to the accuracy of the composition/document. |
Control | 0..* |
Type | BackboneElement |
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() or (children().count() > id.count())) |
45. 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 |
46. Composition.attester.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. |
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()) |
47. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
48. Composition.attester.mode | |
Definition | The type of attestation the authenticator offers. |
Control | 1..1 |
Binding | The codes SHALL be taken from CompositionAttestationMode The way in which a person authenticated a composition. |
Type | code |
Requirements | Indicates the level of authority of the attestation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
49. Composition.attester.time | |
Definition | When the composition was attested by the party. |
Control | 0..1 |
Type | dateTime |
Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
50. Composition.attester.party | |
Definition | Who attested the composition in the specified way. |
Control | 0..1 |
Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) |
Requirements | Identifies who has taken on the responsibility for accuracy of the composition content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
51. 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) |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
52. Composition.relatesTo | |
Definition | Relationships that this composition has with other compositions or documents that already exist. |
Control | 0..* |
Type | BackboneElement |
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() or (children().count() > id.count())) |
53. 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 |
54. Composition.relatesTo.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. |
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()) |
55. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
56. Composition.relatesTo.code | |
Definition | The type of relationship that this composition has with anther composition or document. |
Control | 1..1 |
Binding | The codes SHALL be taken from DocumentRelationshipType The type of relationship between documents. |
Type | code |
Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
57. Composition.relatesTo.target[x] | |
Definition | The target composition/document of this relationship. |
Control | 1..1 |
Type | Choice of: Identifier, Reference(Composition) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
58. Composition.event | |
Definition | The clinical service, such as a colonoscopy or an appendectomy, being documented. |
Control | 0..* |
Type | BackboneElement |
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() or (children().count() > id.count())) |
59. 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 |
60. Composition.event.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. |
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()) |
61. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
62. 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 | For example codes, see v3 Code System ActCode This list of codes represents the main clinical acts being documented. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
63. 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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
64. 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) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
65. Composition.section | |
Definition | The root of the sections that make up the composition. |
Control | 3..13 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Composition.section. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
66. 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 |
67. Composition.section.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. |
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()) |
68. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
69. 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
70. Composition.section.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
71. Composition.section.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
72. Composition.section.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
73. 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 |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
74. 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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
75. Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
76. 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) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
77. 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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
78. 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 ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
79. Composition.section:PatientInformation | |
SliceName | PatientInformation |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
80. Composition.section:PatientInformation.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 |
81. Composition.section:PatientInformation.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. |
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()) |
82. Composition.section:PatientInformation.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
83. Composition.section:PatientInformation.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. |
Pattern Value | Patient Information |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
84. Composition.section:PatientInformation.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="PatientInformation"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
85. Composition.section:PatientInformation.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
86. Composition.section:PatientInformation.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
87. Composition.section:PatientInformation.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
88. Composition.section:PatientInformation.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
89. Composition.section:PatientInformation.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
90. Composition.section:PatientInformation.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(Observation) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
91. Composition.section:PatientInformation.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
92. Composition.section:PatientInformation.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
93. Composition.section:RelevantMedicalHistory | |
SliceName | RelevantMedicalHistory |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
94. Composition.section:RelevantMedicalHistory.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 |
95. Composition.section:RelevantMedicalHistory.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. |
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()) |
96. Composition.section:RelevantMedicalHistory.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
97. Composition.section:RelevantMedicalHistory.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. |
Pattern Value | Relevant Medical History |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
98. Composition.section:RelevantMedicalHistory.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="RelevantMedicalHistory"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
99. Composition.section:RelevantMedicalHistory.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
100. Composition.section:RelevantMedicalHistory.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
101. Composition.section:RelevantMedicalHistory.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
102. Composition.section:RelevantMedicalHistory.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
103. Composition.section:RelevantMedicalHistory.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
104. Composition.section:RelevantMedicalHistory.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(Condition) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
105. Composition.section:RelevantMedicalHistory.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
106. Composition.section:RelevantMedicalHistory.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
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:RelevantPastDrugHistory | |
SliceName | RelevantPastDrugHistory |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
108. Composition.section:RelevantPastDrugHistory.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 |
109. Composition.section:RelevantPastDrugHistory.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. |
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()) |
110. Composition.section:RelevantPastDrugHistory.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
111. Composition.section:RelevantPastDrugHistory.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. |
Pattern Value | Relevant Past Drug History |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
112. Composition.section:RelevantPastDrugHistory.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="RelevantPastDrugHistory"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
113. Composition.section:RelevantPastDrugHistory.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
114. Composition.section:RelevantPastDrugHistory.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
115. Composition.section:RelevantPastDrugHistory.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
116. Composition.section:RelevantPastDrugHistory.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
117. Composition.section:RelevantPastDrugHistory.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
118. Composition.section:RelevantPastDrugHistory.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(MedicationStatement) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
119. Composition.section:RelevantPastDrugHistory.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
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:RelevantPastDrugHistory.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
121. Composition.section:InCaseOfDeath | |
SliceName | InCaseOfDeath |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
122. Composition.section:InCaseOfDeath.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 |
123. Composition.section:InCaseOfDeath.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. |
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()) |
124. Composition.section:InCaseOfDeath.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
125. Composition.section:InCaseOfDeath.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. |
Pattern Value | In Case of Death |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
126. Composition.section:InCaseOfDeath.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="InCaseOfDeath"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
127. Composition.section:InCaseOfDeath.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
128. Composition.section:InCaseOfDeath.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
129. Composition.section:InCaseOfDeath.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
130. Composition.section:InCaseOfDeath.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
131. Composition.section:InCaseOfDeath.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
132. Composition.section:InCaseOfDeath.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(Observation) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
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:InCaseOfDeath.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
134. Composition.section:InCaseOfDeath.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
135. Composition.section:ParentInformation | |
SliceName | ParentInformation |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
136. Composition.section:ParentInformation.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 |
137. Composition.section:ParentInformation.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. |
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()) |
138. Composition.section:ParentInformation.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
139. Composition.section:ParentInformation.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. |
Pattern Value | Parent Information |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
140. Composition.section:ParentInformation.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="ParentInformation"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
141. Composition.section:ParentInformation.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
142. Composition.section:ParentInformation.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
143. Composition.section:ParentInformation.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
144. Composition.section:ParentInformation.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
145. Composition.section:ParentInformation.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
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:ParentInformation.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(Patient | Condition | MedicationStatement) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
147. Composition.section:ParentInformation.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
148. Composition.section:ParentInformation.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
149. Composition.section:ReactionEvent | |
SliceName | ReactionEvent |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
150. Composition.section:ReactionEvent.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 |
151. Composition.section:ReactionEvent.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. |
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()) |
152. Composition.section:ReactionEvent.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
153. Composition.section:ReactionEvent.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. |
Pattern Value | Reaction/Event |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
154. Composition.section:ReactionEvent.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="ReactionEvent"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
155. Composition.section:ReactionEvent.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
156. Composition.section:ReactionEvent.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
157. Composition.section:ReactionEvent.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
158. Composition.section:ReactionEvent.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
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:ReactionEvent.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
160. Composition.section:ReactionEvent.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(VAERSAdverseEvent | FAERSAdverseEvent) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
161. Composition.section:ReactionEvent.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
162. Composition.section:ReactionEvent.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
163. Composition.section:RelevantLabTestResults | |
SliceName | RelevantLabTestResults |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
164. Composition.section:RelevantLabTestResults.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 |
165. Composition.section:RelevantLabTestResults.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. |
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()) |
166. Composition.section:RelevantLabTestResults.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
167. Composition.section:RelevantLabTestResults.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. |
Pattern Value | Relevant Lab Test Results |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
168. Composition.section:RelevantLabTestResults.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="RelevantLabTestResults"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
169. Composition.section:RelevantLabTestResults.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
170. Composition.section:RelevantLabTestResults.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
171. Composition.section:RelevantLabTestResults.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. |
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:RelevantLabTestResults.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
173. Composition.section:RelevantLabTestResults.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
174. Composition.section:RelevantLabTestResults.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(Observation) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
175. Composition.section:RelevantLabTestResults.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
176. Composition.section:RelevantLabTestResults.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
177. Composition.section:DrugInformation | |
SliceName | DrugInformation |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
178. Composition.section:DrugInformation.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 |
179. Composition.section:DrugInformation.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. |
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()) |
180. Composition.section:DrugInformation.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
181. Composition.section:DrugInformation.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. |
Pattern Value | Drug Information |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
182. Composition.section:DrugInformation.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="DrugInformation"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
183. Composition.section:DrugInformation.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
184. Composition.section:DrugInformation.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
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:DrugInformation.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
186. Composition.section:DrugInformation.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
187. Composition.section:DrugInformation.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
188. Composition.section:DrugInformation.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(ICSRMedicationAdministration | ICSRImmunization | DeviceUseStatement | ICSRTransfusion) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
189. Composition.section:DrugInformation.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
190. Composition.section:DrugInformation.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
191. Composition.section:VAERSVaccines | |
SliceName | VAERSVaccines |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
192. Composition.section:VAERSVaccines.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 |
193. Composition.section:VAERSVaccines.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. |
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()) |
194. Composition.section:VAERSVaccines.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
195. Composition.section:VAERSVaccines.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. |
Pattern Value | VAERS Vaccines given within 4 weeks |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
196. Composition.section:VAERSVaccines.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="VAERSVaccines"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
197. Composition.section:VAERSVaccines.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
198. Composition.section:VAERSVaccines.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
199. Composition.section:VAERSVaccines.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
200. Composition.section:VAERSVaccines.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
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:VAERSVaccines.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
202. Composition.section:VAERSVaccines.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(ICSRImmunization) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
203. Composition.section:VAERSVaccines.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
204. Composition.section:VAERSVaccines.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
205. Composition.section:CaseNarrative | |
SliceName | CaseNarrative |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
206. Composition.section:CaseNarrative.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 |
207. Composition.section:CaseNarrative.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. |
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()) |
208. Composition.section:CaseNarrative.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
209. Composition.section:CaseNarrative.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. |
Pattern Value | Case Summary Narrative |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
210. Composition.section:CaseNarrative.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="CaseSummaryNarrative"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
211. Composition.section:CaseNarrative.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
212. Composition.section:CaseNarrative.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
213. Composition.section:CaseNarrative.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 |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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:CaseNarrative.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
215. Composition.section:CaseNarrative.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
216. Composition.section:CaseNarrative.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
217. Composition.section:CaseNarrative.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
218. Composition.section:CaseNarrative.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
219. Composition.section:CaseReporterComments | |
SliceName | CaseReporterComments |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
220. Composition.section:CaseReporterComments.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 |
221. Composition.section:CaseReporterComments.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. |
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()) |
222. Composition.section:CaseReporterComments.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
223. Composition.section:CaseReporterComments.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. |
Pattern Value | Case Reporter's Comments |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
224. Composition.section:CaseReporterComments.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="CaseReporterComments"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
225. Composition.section:CaseReporterComments.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
226. Composition.section:CaseReporterComments.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
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:CaseReporterComments.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 |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
228. Composition.section:CaseReporterComments.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
229. Composition.section:CaseReporterComments.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
230. Composition.section:CaseReporterComments.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
231. Composition.section:CaseReporterComments.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
232. Composition.section:CaseReporterComments.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
233. Composition.section:CaseSenderDiagnosis | |
SliceName | CaseSenderDiagnosis |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
234. Composition.section:CaseSenderDiagnosis.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 |
235. Composition.section:CaseSenderDiagnosis.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. |
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()) |
236. Composition.section:CaseSenderDiagnosis.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
237. Composition.section:CaseSenderDiagnosis.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. |
Pattern Value | Case Sender's Diagnosis |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
238. Composition.section:CaseSenderDiagnosis.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="CaseSenderDiagnosis"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
239. Composition.section:CaseSenderDiagnosis.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
240. Composition.section:CaseSenderDiagnosis.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
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:CaseSenderDiagnosis.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
242. Composition.section:CaseSenderDiagnosis.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
243. Composition.section:CaseSenderDiagnosis.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
244. Composition.section:CaseSenderDiagnosis.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(Condition) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
245. Composition.section:CaseSenderDiagnosis.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
246. Composition.section:CaseSenderDiagnosis.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
247. Composition.section:CaseSenderComments | |
SliceName | CaseSenderComments |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
248. Composition.section:CaseSenderComments.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:CaseSenderComments.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. |
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()) |
250. Composition.section:CaseSenderComments.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
251. Composition.section:CaseSenderComments.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. |
Pattern Value | Case Sender's Comments |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
252. Composition.section:CaseSenderComments.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="CaseSenderComments"/> </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:CaseSenderComments.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
254. Composition.section:CaseSenderComments.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
255. Composition.section:CaseSenderComments.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 |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
256. Composition.section:CaseSenderComments.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
257. Composition.section:CaseSenderComments.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
258. Composition.section:CaseSenderComments.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
259. Composition.section:CaseSenderComments.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
260. Composition.section:CaseSenderComments.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
261. Composition.section:DataSourceInformation | |
SliceName | DataSourceInformation |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must contain 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() or (children().count() > id.count())) |
262. Composition.section:DataSourceInformation.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:DataSourceInformation.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. |
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()) |
264. Composition.section:DataSourceInformation.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
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()) |
265. Composition.section:DataSourceInformation.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. |
Pattern Value | Information about the Data Source of the AE information |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
266. Composition.section:DataSourceInformation.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 | For example codes, see DocumentSectionCodes Classification of a section of a composition/document. |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/icsr-ae-reporting/CodeSystem/ICSRSectionCodeCS"/> <code value="DataSourceInformation"/> </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:DataSourceInformation.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
268. Composition.section:DataSourceInformation.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
269. Composition.section:DataSourceInformation.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
270. Composition.section:DataSourceInformation.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 codes SHALL be taken from ListMode The processing mode that applies to this section. |
Type | code |
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 misunderstood as a complete list. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
271. Composition.section:DataSourceInformation.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
Binding | The codes SHOULD be taken from ListOrderCodes What order applies to the items in the entry. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
272. Composition.section:DataSourceInformation.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(AECountObservation | ExposureCountObservation) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
273. Composition.section:DataSourceInformation.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 | The codes SHOULD be taken from ListEmptyReasons If a section is empty, why it is empty. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
274. Composition.section:DataSourceInformation.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |