IPS

There are no (further) constraints on this element

Element id

Composition.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

category

0..*

There are no (further) constraints on this element

Element id

Composition.category

Short description

Categorization of Composition

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.

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.

Data type

DocumentClassValueSet (example)

Binding

High-level kind of a clinical document at a macro level.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.subject
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
cda: n/a
fhirdocumentreference: DocumenttReference.category

subject

SO Σ C

1..1

Reference(PatientUvIps)

Element id

Composition.subject

Short description

Who and/or what the composition is about

Definition

Who or what the composition is about. In general a composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). For the IPS the subject is always the patient.

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.

Data type

Reference(PatientUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
cda: .recordTarget
fhirdocumentreference: DocumentReference.subject
w5: FiveWs.subject

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.subject.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Composition.subject.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

reference

SO Σ C

1..1

Element id

Composition.subject.reference

Short description

Literal reference, Relative, internal or absolute URL

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.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Composition.subject.type

Short description

Type the reference refers to (e.g. "Patient")

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).

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.

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

Composition.subject.identifier

Short description

Logical reference, when literal reference is not known

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.

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).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

Composition.subject.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

encounter

Σ C

0..1

Reference(Encounter)

There are no (further) constraints on this element

Element id

Composition.encounter

Short description

Context of the Composition

Definition

Describes the clinical encounter or type of care this documentation is associated with.

Requirements

Provides context for the composition and supports searching.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Encounter)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
w5: FiveWs.context
rim: unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
cda: .componentOf.encompassingEncounter
fhirdocumentreference: DocumentReference.context.encounter

date

SO Σ

1..1

Element id

Composition.date

Short description

Composition editing time

Definition

The composition editing time, when the composition was last logically changed by the author.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
rim: .effectiveTime[type="TS"]
cda: .effectiveTime
fhirdocumentreference: DocumentReference.content.attachment.date, DocumentReference.created

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

SO Σ C

1..*

Element id

Composition.author

Short description

Who and/or what authored the IPS

Definition

Identifies who is responsible for the information in the composition, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

The distinction between the two types of IPS, "human-curated" or "software-assembled", is based on the authors recorded in this field: the author refers to humans (i.e. Practitioner, PractitionerRole, Patient, and/or RelatedPerson) if the IPS provenance is "human-curated", or devices (i.e. Device) if the IPS provenance is "software-assembled". In the case of a software-assembled IPS that is then verified by a human, the author would be the device that constructed the IPS document, but additional attesters would identity the humans who performed this check.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.performer
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor
fhirdocumentreference: DocumentReference.agent

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

title

SO Σ

1..1

Element id

Composition.title

Short description

The title of this patient summary. This may include information like the patient name and time generated

Definition

Official human-readable label for the composition.

This would typically include a label of "International Patient Summary" or any equivalent translation and other relevant document information

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title
fhirdocumentreference: DocumentReference.description, DocumentReference.content.attachment.title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

confidentiality

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.confidentiality

Short description

As defined by affinity domain

Definition

The code specifying the level of confidentiality of the Composition.

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.

Data type

v3.ConfidentialityClassification (required)

Binding

Codes specifying the level of confidentiality of the composition.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .confidentialityCode
cda: .confidentialityCode
fhirdocumentreference: DocumentReference.securityLabel

attester

0..*

Element id

Composition.attester

Short description

Attests to accuracy of composition

Definition

A participant who has attested to the accuracy of the composition/document.

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
cda: .authenticator/.legalAuthenticator
fhirdocumentreference: DocumentReference.authenticator

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.attester.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Composition.attester.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.attester.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

mode

1..1

codeBinding

Element id

Composition.attester.mode

Short description

personal | professional | legal | official

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

CompositionAttestationMode (required)

Binding

The way in which a person authenticated a composition.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: unique(./modeCode)
cda: implied by .authenticator/.legalAuthenticator

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

time

0..1

Element id

Composition.attester.time

Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./time[type="TS" and isNormalDatatype()]
cda: .authenticator.time

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

party

SO C

0..1

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

Element id

Composition.attester.party

Short description

Who attested the composition

Definition

Who attested the composition in the specified way.

Requirements

Identifies who has taken on the responsibility for accuracy of the composition content.

Comments

Data type

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.witness
rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
cda: .authenticator.assignedEnttty

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

custodian

SO Σ C

0..1

Reference(Organization)

Element id

Composition.custodian

Short description

Organization which maintains the composition

Definition

Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
cda: .custodian.assignedCustodian
fhirdocumentreference: DocumentReference.custodian

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

relatesTo

0..*

There are no (further) constraints on this element

Element id

Composition.relatesTo

Short description

Relationships to other compositions/documents

Definition

Relationships that this composition has with other compositions or documents that already exist.

Comments

A document is a version specific composition.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship
cda: .relatedDocument
fhirdocumentreference: DocumentReference.relatesTo

0..1

There are no (further) constraints on this element

Element id

Composition.relatesTo.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Composition.relatesTo.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.relatesTo.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

code

1..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.relatesTo.code

Short description

replaces | transforms | signs | appends

Definition

The type of relationship that this composition has with anther composition or document.

Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

Data type

DocumentRelationshipType (required)

Binding

The type of relationship between documents.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship.typeCode
cda: .relatedDocument.typeCode
fhirdocumentreference: DocumentReference.relatesTo.code

target[x]

1..1

There are no (further) constraints on this element

Element id

Composition.relatesTo.target[x]

Short description

Target of the relationship

Definition

The target composition/document of this relationship.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .target[classCode="DOC", moodCode="EVN"].id
cda: .relatedDocument.id
fhirdocumentreference: DocumentReference.relatesTo.target

targetIdentifier

Data type

targetReference

Reference(Composition | CompositionUvIps)

Data type

Reference(Composition | CompositionUvIps)

event

0..*

Element id

Composition.event

Short description

The clinical service(s) being documented

Definition

The main activity being described by a IPS is the provision of healthcare over a period of time. In the CDA representation of the IPS this is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. In the FHIR representation at least one event should be used to record this information. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range). For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the start value should represent the date when the treatment relationship between the patient and the GP started; and the end value the date of the latest care event.

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.

Data type

Slicing

Unordered, Open, by code(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
cda: .documentationOf.serviceEvent
fhirdocumentreference: DocumentReference.event

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Composition.event.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Composition.event.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.event.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

code

0..*

There are no (further) constraints on this element

Element id

Composition.event.code

Short description

Code(s) that apply to the event being documented

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.

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.

Data type

Binding

This list of codes represents the main clinical acts being documented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code
cda: .code
fhirdocumentreference: DocumentReference.event.code

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Composition.event.period

Short description

The period covered by the documentation

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.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
rim: .effectiveTime
cda: .effectiveTime
fhirdocumentreference: DocumentReference.event.period

detail

Σ C

0..*

There are no (further) constraints on this element

Element id

Composition.event.detail

Short description

The event(s) being documented

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.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode="SUBJ"].target
cda: n/a

careProvisioningEvent

SO Σ

0..1

Element id

Composition.event:careProvisioningEvent

Short description

The care provisioning being documented

Definition

The provision of healthcare over a period of time this IPS is documenting.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
cda: .documentationOf.serviceEvent
fhirdocumentreference: DocumentReference.event

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.event:careProvisioningEvent.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Composition.event:careProvisioningEvent.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.event:careProvisioningEvent.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

code

SO Σ

1..1

CodeableConceptPattern

Element id

Composition.event:careProvisioningEvent.code

Short description

Code(s) that apply to the event being documented

Definition

Comments

Data type

Binding

This list of codes represents the main clinical acts being documented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/v3-ActClass",
      "code": "PCPR"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code
cda: .code
fhirdocumentreference: DocumentReference.event.code

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

period

SO Σ C

0..1

Element id

Composition.event:careProvisioningEvent.period

Short description

The period covered by the documentation

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.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
rim: .effectiveTime
cda: .effectiveTime
fhirdocumentreference: DocumentReference.event.period

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

detail

Σ C

0..*

There are no (further) constraints on this element

Element id

Composition.event:careProvisioningEvent.detail

Short description

The event(s) being documented

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.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode="SUBJ"].target
cda: n/a

section

SO C

3..*

Element id

Composition.section

Short description

Sections composing the IPS

Definition

The root of the sections that make up the IPS composition.

Data type

Slicing

Unordered, Open, by code(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Composition.section.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

Element id

Composition.section.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section.focus

Short description

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

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).

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section.text

Short description

Text summary of the section, for human interpretation

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section.mode

Short description

working | snapshot | changes

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.

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

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.

Data type

Binding

What order applies to the items in the entry.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

There are no (further) constraints on this element

Element id

Composition.section.entry

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

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.

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionProblems

SO C

1..1

Element id

Composition.section:sectionProblems

Short description

IPS Problems Section

Definition

The IPS problem section lists and describes clinical problems or conditions currently being monitored for the patient.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()
ips-comp-1: Either section.entry or emptyReason are present
(entry.reference.exists() or emptyReason.exists())

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionProblems.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionProblems.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionProblems.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionProblems.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionProblems.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionProblems.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11450-4"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionProblems.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionProblems.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionProblems.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionProblems.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionProblems.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Element id

Composition.section:sectionProblems.entry

Short description

Clinical problems or conditions currently being monitored for the patient.

Definition

It lists and describes clinical problems or conditions currently being monitored for the patient. This entry shall be used to document that no information about problems is available, or that no relevant problems are known.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

problem

SO C

0..*

Element id

Composition.section:sectionProblems.entry:problem

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHALL:able-to-populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

emptyReason

SO C

0..1

CodeableConceptBinding

Element id

Composition.section:sectionProblems.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionProblems.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionAllergies

SO C

1..1

Element id

Composition.section:sectionAllergies

Short description

IPS Allergies and Intolerances Section

Definition

This section documents the relevant allergies or intolerances for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. If no information about allergies is available, or if no allergies are known this should be clearly documented in the section.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()
ips-comp-1: Either section.entry or emptyReason are present
(entry.reference.exists() or emptyReason.exists())

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionAllergies.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionAllergies.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionAllergies.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionAllergies.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionAllergies.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionAllergies.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48765-2"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionAllergies.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionAllergies.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionAllergies.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionAllergies.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionAllergies.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Reference(AllergyIntoleranceUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(AllergyIntolerance | DocumentReference)

Element id

Composition.section:sectionAllergies.entry

Short description

Relevant allergies or intolerances for that patient.

Definition

It lists the relevant allergies or intolerances for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. This entry shall be used to document that no information about allergies is available, or that no allergies are known .

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(AllergyIntolerance | DocumentReference)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

allergyOrIntolerance

SO C

0..*

Element id

Composition.section:sectionAllergies.entry:allergyOrIntolerance

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(AllergyIntoleranceUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHALL:able-to-populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

emptyReason

SO C

0..1

CodeableConceptBinding

Element id

Composition.section:sectionAllergies.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionAllergies.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionMedications

SO C

1..1

Element id

Composition.section:sectionMedications

Short description

IPS Medication Summary Section

Definition

The medication summary section contains a description of the patient's medications relevant for the scope of the patient summary. The actual content could depend on the jurisdiction, it could report:

the currently active medications;
the current and past medications considered relevant by the authoring GP;
the patient prescriptions or dispensations automatically extracted by a regional or a national EHR.

In those cases medications are documented in the Patient Summary as medication statements or medication requests. This section requires either an entry indicating the subject is known not to be on any relevant medication; either an entry indicating that no information is available about medications; or entries summarizing the subject's relevant medications.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()
ips-comp-1: Either section.entry or emptyReason are present
(entry.reference.exists() or emptyReason.exists())

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionMedications.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionMedications.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionMedications.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionMedications.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionMedications.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionMedications.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10160-0"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionMedications.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionMedications.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionMedications.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionMedications.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionMedications.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Reference(MedicationRequestIPS | MedicationStatementIPS)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(DocumentReference | MedicationAdministration | MedicationDispense | MedicationRequest | MedicationStatement)

Element id

Composition.section:sectionMedications.entry

Short description

Medications relevant for the scope of the patient summary

Definition

This list the medications relevant for the scope of the patient summary or it is used to indicate that the subject is known not to be on any relevant medication; either that no information is available about medications.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(DocumentReference | MedicationAdministration | MedicationDispense | MedicationRequest | MedicationStatement)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

medicationStatementOrRequest

SO C

0..*

Element id

Composition.section:sectionMedications.entry:medicationStatementOrRequest

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(MedicationRequestIPS | MedicationStatementIPS)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHALL:able-to-populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

emptyReason

SO C

0..1

CodeableConceptBinding

Element id

Composition.section:sectionMedications.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionMedications.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionImmunizations

SO C

0..1

Element id

Composition.section:sectionImmunizations

Short description

IPS Immunizations Section

Definition

The Immunizations Section defines a patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. The section includes the current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionImmunizations.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionImmunizations.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionImmunizations.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionImmunizations.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionImmunizations.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionImmunizations.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11369-6"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionImmunizations.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionImmunizations.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionImmunizations.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionImmunizations.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionImmunizations.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Reference(ImmunizationUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(DocumentReference | Immunization)

Element id

Composition.section:sectionImmunizations.entry

Short description

Patient's immunization status and pertinent history.

Definition

It defines the patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. It may contain the entire immunization history that is relevant to the period of time being summarized. This entry shall be used to document that no information about immunizations is available, or that no immunizations are known.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(DocumentReference | Immunization)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

immunization

SO C

0..*

Element id

Composition.section:sectionImmunizations.entry:immunization

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ImmunizationUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionImmunizations.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionImmunizations.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionResults

SO C

0..1

Element id

Composition.section:sectionResults

Short description

IPS Results Section

Definition

This section assembles relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionResults.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionResults.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionResults.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionResults.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionResults.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionResults.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "30954-2"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionResults.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionResults.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionResults.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionResults.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionResults.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Reference(ObservationResultsLaboratoryPathologyUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(DiagnosticReport | DocumentReference | Observation)

Element id

Composition.section:sectionResults.entry

Short description

Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient.

Definition

Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(DiagnosticReport | DocumentReference | Observation)

Slicing

Unordered, Open, by resolve()(Type), resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

results-observation-laboratory-pathology

SO C

0..*

Element id

Composition.section:sectionResults.entry:results-observation-laboratory-pathology

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationResultsLaboratoryPathologyUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

results-observation-radiology

SO C

0..*

Reference(ObservationResultsRadiologyUvIps)

Element id

Composition.section:sectionResults.entry:results-observation-radiology

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationResultsRadiologyUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

results-diagnosticReport

SO C

0..*

Reference(DiagnosticReportUvIps)

Element id

Composition.section:sectionResults.entry:results-diagnosticReport

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(DiagnosticReportUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionResults.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionResults.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionProceduresHx

SO C

0..1

Element id

Composition.section:sectionProceduresHx

Short description

IPS History of Procedures Section

Definition

The History of Procedures Section contains a description of the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to:

Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section)
Therapeutic procedure: e.g. dialysis;
Surgical procedure: e.g. appendectomy

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionProceduresHx.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionProceduresHx.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionProceduresHx.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionProceduresHx.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionProceduresHx.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionProceduresHx.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47519-4"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionProceduresHx.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionProceduresHx.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionProceduresHx.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionProceduresHx.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionProceduresHx.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Reference(ProcedureUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(DocumentReference | Procedure)

Element id

Composition.section:sectionProceduresHx.entry

Short description

Patient past procedures pertinent to the scope of this document.

Definition

It lists the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to:

Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section)
Therapeutic procedure: e.g. dialysis;
Surgical procedure: e.g. appendectomy. This entry shall be used to document that no information about past procedures is available, or that no relevant past procedures are known.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(DocumentReference | Procedure)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

procedure

SO C

0..*

Element id

Composition.section:sectionProceduresHx.entry:procedure

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ProcedureUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionProceduresHx.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionProceduresHx.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionMedicalDevices

SO C

0..1

Element id

Composition.section:sectionMedicalDevices

Short description

IPS Medical Devices Section

Definition

The medical devices section contains narrative text and coded entries describing the patient history of medical device use.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionMedicalDevices.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionMedicalDevices.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionMedicalDevices.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionMedicalDevices.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionMedicalDevices.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionMedicalDevices.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "46264-8"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionMedicalDevices.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionMedicalDevices.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionMedicalDevices.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionMedicalDevices.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionMedicalDevices.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Reference(DeviceUseStatementUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(DeviceUseStatement | DocumentReference)

Element id

Composition.section:sectionMedicalDevices.entry

Short description

Patient history of medical device use.

Definition

It describes the patient history of medical device use. This entry shall be used to document that no information about medical device use is available, or that no relevant medical device use is known.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(DeviceUseStatement | DocumentReference)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

deviceStatement

SO C

0..*

Element id

Composition.section:sectionMedicalDevices.entry:deviceStatement

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(DeviceUseStatementUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionMedicalDevices.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionMedicalDevices.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionAdvanceDirectives

SO C

0..1

Element id

Composition.section:sectionAdvanceDirectives

Short description

IPS Advance Directives Section

Definition

The advance directives section contains a narrative description of patient's advance directive.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionAdvanceDirectives.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionAdvanceDirectives.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionAdvanceDirectives.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionAdvanceDirectives.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionAdvanceDirectives.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionAdvanceDirectives.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "42348-3"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionAdvanceDirectives.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionAdvanceDirectives.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionAdvanceDirectives.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionAdvanceDirectives.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionAdvanceDirectives.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(Consent | DocumentReference)

Element id

Composition.section:sectionAdvanceDirectives.entry

Short description

Narrative description of the patient's advance directive.

Definition

Contains a narrative description or a Consent entry with information about the patient's advance directive.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Consent | DocumentReference)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

advanceDirectivesConsent

0..*

Reference(Consent)

Element id

Composition.section:sectionAdvanceDirectives.entry:advanceDirectivesConsent

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Consent)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionAdvanceDirectives.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionAdvanceDirectives.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionAlerts

SO C

0..1

Element id

Composition.section:sectionAlerts

Short description

IPS Alerts Section

Definition

The alerts section flags potential concerns and/or dangers to/from the patient and may also include obstacles to care.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionAlerts.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionAlerts.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionAlerts.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionAlerts.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionAlerts.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionAlerts.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "104605-1"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionAlerts.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionAlerts.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionAlerts.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionAlerts.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionAlerts.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Reference(FlagAlertUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(DocumentReference | Flag)

Element id

Composition.section:sectionAlerts.entry

Short description

Alert information.

Definition

Contains alert information to be communicated. May optionally reference other resources in IPS.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(DocumentReference | Flag)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

alertsFlag

0..*

Element id

Composition.section:sectionAlerts.entry:alertsFlag

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(FlagAlertUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionAlerts.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionAlerts.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionFunctionalStatus

SO C

0..1

Element id

Composition.section:sectionFunctionalStatus

Short description

IPS Functional Status

Definition

The functional status section shall contain a narrative description of capability of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionFunctionalStatus.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionFunctionalStatus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionFunctionalStatus.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionFunctionalStatus.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionFunctionalStatus.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionFunctionalStatus.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47420-5"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionFunctionalStatus.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionFunctionalStatus.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionFunctionalStatus.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionFunctionalStatus.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionFunctionalStatus.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(ClinicalImpression | Condition | DocumentReference)

Element id

Composition.section:sectionFunctionalStatus.entry

Short description

Optional entry used to represent disabilities and functional assessments

Definition

It describes capabilities of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ClinicalImpression | Condition | DocumentReference)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

disability

0..*

Element id

Composition.section:sectionFunctionalStatus.entry:disability

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ClinicalImpression)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

functionalAssessment

0..*

Element id

Composition.section:sectionFunctionalStatus.entry:functionalAssessment

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ClinicalImpression)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionFunctionalStatus.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionFunctionalStatus.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionPastProblems

SO C

0..1

Element id

Composition.section:sectionPastProblems

Short description

IPS History of Past Problems Section

Definition

The History of Past Problems section contains a description of the conditions the patient suffered in the past but no longer tracked in the Problem List.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionPastProblems.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionPastProblems.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionPastProblems.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionPastProblems.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionPastProblems.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionPastProblems.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11348-0"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionPastProblems.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionPastProblems.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionPastProblems.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPastProblems.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPastProblems.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Element id

Composition.section:sectionPastProblems.entry

Short description

Conditions the patient suffered in the past.

Definition

It contains a description of the conditions the patient suffered in the past.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

pastProblem

0..*

Element id

Composition.section:sectionPastProblems.entry:pastProblem

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPastProblems.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionPastProblems.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionPregnancyHx

SO C

0..1

Element id

Composition.section:sectionPregnancyHx

Short description

IPS History of Pregnancy Section

Definition

The history of pregnancy section shall contain information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionPregnancyHx.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionPregnancyHx.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionPregnancyHx.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionPregnancyHx.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionPregnancyHx.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionPregnancyHx.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10162-6"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionPregnancyHx.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionPregnancyHx.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionPregnancyHx.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPregnancyHx.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPregnancyHx.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Element id

Composition.section:sectionPregnancyHx.entry

Short description

Current pregnancy status and, optionally, information about the outcome of earlier pregnancies.

Definition

It contains information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationPregnancyStatusUvIps)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

pregnancyStatus

0..*

Element id

Composition.section:sectionPregnancyHx.entry:pregnancyStatus

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationPregnancyStatusUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

pregnancyOutcome

0..*

Reference(ObservationPregnancyOutcomeUvIps)

Element id

Composition.section:sectionPregnancyHx.entry:pregnancyOutcome

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationPregnancyOutcomeUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPregnancyHx.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionPregnancyHx.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionPatientStory

SO C

0..1

Element id

Composition.section:sectionPatientStory

Short description

IPS Patient Story Section

Definition

The section contains narrative text along with optional resources that express what matters to a patient. This may include needs, strengths, values, concerns and preferences to others providing support and care. The patient’s story, provided here, may be told by the patient or by a proxy.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionPatientStory.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionPatientStory.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionPatientStory.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionPatientStory.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionPatientStory.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionPatientStory.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "81338-6"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionPatientStory.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionPatientStory.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionPatientStory.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPatientStory.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPatientStory.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Element id

Composition.section:sectionPatientStory.entry

Short description

Patient Story resources.

Definition

Contains resources to support the Patient Story. Instances of DocumentReference or any other suitable resource type may be used.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPatientStory.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionPatientStory.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionPlanOfCare

SO C

0..1

Element id

Composition.section:sectionPlanOfCare

Short description

IPS Plan of Care Section

Definition

The plan of care section contains a narrative description of the expectations for care including proposals, goals, and order requests for monitoring, tracking, or improving the condition of the patient.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionPlanOfCare.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionPlanOfCare.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionPlanOfCare.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionPlanOfCare.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionPlanOfCare.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionPlanOfCare.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "18776-5"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionPlanOfCare.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionPlanOfCare.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionPlanOfCare.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPlanOfCare.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPlanOfCare.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Reference(ImmunizationRecommendation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Reference(CarePlan | DocumentReference | ImmunizationRecommendation)

Element id

Composition.section:sectionPlanOfCare.entry

Short description

Optional entry used to represent structured care plans

Definition

Dynamic, personalized plan including identified needed healthcare activity, health objectives and healthcare goals, relating to one or more specified health issues in a healthcare process [Source EN ISO 13940]

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(CarePlan | DocumentReference | ImmunizationRecommendation)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

carePlan

0..*

Reference(CarePlan)

Element id

Composition.section:sectionPlanOfCare.entry:carePlan

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(CarePlan)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

immunizationRecommendation

0..*

Element id

Composition.section:sectionPlanOfCare.entry:immunizationRecommendation

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ImmunizationRecommendation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionPlanOfCare.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionPlanOfCare.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionSocialHistory

SO C

0..1

Element id

Composition.section:sectionSocialHistory

Short description

IPS Social History Section

Definition

The social history section contains a description of the person’s Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionSocialHistory.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionSocialHistory.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionSocialHistory.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionSocialHistory.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionSocialHistory.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionSocialHistory.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "29762-2"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionSocialHistory.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionSocialHistory.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionSocialHistory.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionSocialHistory.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionSocialHistory.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Element id

Composition.section:sectionSocialHistory.entry

Short description

Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)

Definition

Description of the person’s Health related “lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationTobaccoUseUvIps)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

smokingTobaccoUse

0..1

Element id

Composition.section:sectionSocialHistory.entry:smokingTobaccoUse

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationTobaccoUseUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

alcoholUse

0..1

Reference(ObservationAlcoholUseUvIps)

Element id

Composition.section:sectionSocialHistory.entry:alcoholUse

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationAlcoholUseUvIps)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionSocialHistory.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionSocialHistory.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

sectionVitalSigns

SO C

0..1

Element id

Composition.section:sectionVitalSigns

Short description

IPS Vital Signs Section

Definition

The Vital signs section includes blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionVitalSigns.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Composition.section:sectionVitalSigns.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

section-note

0..*

Element id

Composition.section:sectionVitalSigns.extension:section-note

Short description

Additional notes that apply to the section (but not to specific resource).

Alternate names

extensions, user content

Definition

Additional notes that apply to the section (but not to specific resource).

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Data type

http://hl7.org/fhir/StructureDefinition/note|5.3.0-ballot-tc1

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionVitalSigns.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

title

1..1

Element id

Composition.section:sectionVitalSigns.title

Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

code

1..1

CodeableConceptPattern

Element id

Composition.section:sectionVitalSigns.code

Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

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.

Data type

Binding

Classification of a section of a composition/document.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8716-3"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

author

0..*

There are no (further) constraints on this element

Element id

Composition.section:sectionVitalSigns.author

Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

focus

0..1

There are no (further) constraints on this element

Element id

Composition.section:sectionVitalSigns.focus

Short description

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

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

text

SO C

1..1

Element id

Composition.section:sectionVitalSigns.text

Short description

Text summary of the section, for human interpretation

Definition

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionVitalSigns.mode

Short description

working | snapshot | changes

Definition

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.

Data type

Binding

The processing mode that applies to this section.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

orderedBy

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionVitalSigns.orderedBy

Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Data type

Binding

What order applies to the items in the entry.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

entry

0..*

Element id

Composition.section:sectionVitalSigns.entry

Short description

Notable vital signs or physical findings.

Definition

Notable vital signs or physical findings as: blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(observation-vitalsigns)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

vitalSign

0..*

Element id

Composition.section:sectionVitalSigns.entry:vitalSign

Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(observation-vitalsigns)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

emptyReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Composition.section:sectionVitalSigns.emptyReason

Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Data type

Binding

If a section is empty, why it is empty.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

section

0..0

see (section)

There are no (further) constraints on this element

Element id

Composition.section:sectionVitalSigns.section

Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Detailed Information

Composition

Short International Patient Summary composition

Definition

Cardinality 0..*

Comments

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
workflow: Event
rim: Document[classCode="DOC" and moodCode="EVN" and isNormalAct()]
cda: ClinicalDocument
fhirdocumentreference: when described by DocumentReference

Composition.id

Short Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality 0..1

Summary True

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Composition.meta

Short Metadata about the resource

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.

Cardinality 0..1

Meta

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Composition.meta.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.meta.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.meta.versionId

Short Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Cardinality 0..1

Summary True

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Composition.meta.lastUpdated

Short When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Cardinality 0..1

instant

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Composition.meta.source

Short Identifies where the resource comes from

Definition

Cardinality 0..1

Summary True

Comments

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Composition.meta.profile

Short The conformance of this Composition to a specific IPS version.

Definition

The conformance of this Composition to a specific version of the IPS (e.g. http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips|2.0.0 for 2.0.0)

Cardinality 0..*

Type canonical(StructureDefinition)

Must Support True

Summary True

Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Obligations

Code	Actor
MAY:able-to-populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator

Composition.meta.security

Short Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Cardinality 0..*

Coding

All Security Labels (extensible)

Security Labels from the Healthcare Privacy and Security Classification System.

Summary True

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Composition.meta.tag

Short Tags applied to this resource

Definition

Cardinality 0..*

Coding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Summary True

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Composition.implicitRules

Short A set of rules under which this content was created

Definition

Cardinality 0..1

Modifier True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Composition.language

Short Language of the resource content

Definition

The base language in which the resource is written.

Cardinality 0..1

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Composition.text

Short Text summary of the resource, for human interpretation

Definition

Cardinality 0..1

Must Support True

Alias narrative, html, xhtml, display

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.contained

Short Contained, inline Resources

Definition

Cardinality 0..*

Resource

Alias inline resources, anonymous resources, contained resources

Comments

Mappings

rim: Entity. Role, or Act
rim: N/A

Composition.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.modifierExtension

Short Extensions that cannot be ignored

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Alias extensions, user content

Requirements

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.identifier

Short Version-independent identifier for the Composition

Definition

A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

Cardinality 0..1

Must Support True

Summary True

Comments

Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
w5: FiveWs.identifier
rim: Document.id / Document.setId
cda: .setId
fhirdocumentreference: DocumentReference.masterIdentifier

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.status

Short preliminary | final | amended | entered-in-error

Definition

The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

Cardinality 1..1

The workflow/clinical status of the composition.

CompositionStatus (required)

Must Support True

Modifier True

Summary True

Requirements

Need to be able to mark interim, amended, or withdrawn compositions or documents.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.status
w5: FiveWs.status
rim: interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
cda: n/a
fhirdocumentreference: DocumentReference.status

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.type

Short Kind of composition ("Patient Summary")

Definition

Specifies that this composition refers to a Patient Summary (Loinc "60591-5")

Cardinality 1..1

CodeableConceptIPS

FHIRDocumentTypeCodes (preferred)

Type of a composition.

Must Support True

Summary True

Requirements

Key metadata element describing the composition, used in searching/filtering.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "60591-5"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.code
w5: FiveWs.class
rim: ./code
cda: .code
fhirdocumentreference: DocumentReference.type

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.category

Short Categorization of Composition

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.

Cardinality 0..*

DocumentClassValueSet (example)

High-level kind of a clinical document at a macro level.

Summary 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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.subject
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
cda: n/a
fhirdocumentreference: DocumenttReference.category

Composition.subject

Short Who and/or what the composition is about

Definition

Cardinality 1..1

Type Reference(PatientUvIps)

Must Support True

Summary 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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
cda: .recordTarget
fhirdocumentreference: DocumentReference.subject
w5: FiveWs.subject

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.subject.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.subject.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.subject.reference

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 1..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.subject.type

Short Type the reference refers to (e.g. "Patient")

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.

Cardinality 0..1

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Composition.subject.identifier

Short Logical reference, when literal reference is not known

Definition

Cardinality 0..1

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Composition.subject.display

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..1

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Composition.encounter

Short Context of the Composition

Definition

Describes the clinical encounter or type of care this documentation is associated with.

Cardinality 0..1

Type Reference(Encounter)

Summary True

Requirements

Provides context for the composition and supports searching.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
w5: FiveWs.context
rim: unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
cda: .componentOf.encompassingEncounter
fhirdocumentreference: DocumentReference.context.encounter

Composition.date

Short Composition editing time

Definition

The composition editing time, when the composition was last logically changed by the author.

Cardinality 1..1

Must Support True

Summary 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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
rim: .effectiveTime[type="TS"]
cda: .effectiveTime
fhirdocumentreference: DocumentReference.content.attachment.date, DocumentReference.created

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.author

Short Who and/or what authored the IPS

Definition

Identifies who is responsible for the information in the composition, not necessarily who typed it in.

Cardinality 1..*

Must Support True

Summary True

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.performer
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor
fhirdocumentreference: DocumentReference.agent

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.title

Short The title of this patient summary. This may include information like the patient name and time generated

Definition

Official human-readable label for the composition.

This would typically include a label of "International Patient Summary" or any equivalent translation and other relevant document information

Cardinality 1..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title
fhirdocumentreference: DocumentReference.description, DocumentReference.content.attachment.title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.confidentiality

Short As defined by affinity domain

Definition

The code specifying the level of confidentiality of the Composition.

Cardinality 0..1

v3.ConfidentialityClassification (required)

Codes specifying the level of confidentiality of the composition.

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .confidentialityCode
cda: .confidentialityCode
fhirdocumentreference: DocumentReference.securityLabel

Composition.attester

Short Attests to accuracy of composition

Definition

A participant who has attested to the accuracy of the composition/document.

Cardinality 0..*

Must Support True

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
cda: .authenticator/.legalAuthenticator
fhirdocumentreference: DocumentReference.authenticator

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.attester.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.attester.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.attester.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.attester.mode

Short personal | professional | legal | official

Definition

The type of attestation the authenticator offers.

Cardinality 1..1

CompositionAttestationMode (required)

The way in which a person authenticated a composition.

Must Support True

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: unique(./modeCode)
cda: implied by .authenticator/.legalAuthenticator

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.attester.time

Short When the composition was attested

Definition

When the composition was attested by the party.

Cardinality 0..1

Must Support True

Requirements

Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./time[type="TS" and isNormalDatatype()]
cda: .authenticator.time

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.attester.party

Short Who attested the composition

Definition

Who attested the composition in the specified way.

Cardinality 0..1

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

Must Support True

Requirements

Identifies who has taken on the responsibility for accuracy of the composition content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.witness
rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
cda: .authenticator.assignedEnttty

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.custodian

Short Organization which maintains the composition

Definition

Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

Cardinality 0..1

Type Reference(Organization)

Must Support True

Summary True

Requirements

Identifies where to go to find the current version, where to report issues, etc.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
cda: .custodian.assignedCustodian
fhirdocumentreference: DocumentReference.custodian

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.relatesTo

Short Relationships to other compositions/documents

Definition

Relationships that this composition has with other compositions or documents that already exist.

Cardinality 0..*

Comments

A document is a version specific composition.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship
cda: .relatedDocument
fhirdocumentreference: DocumentReference.relatesTo

Composition.relatesTo.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.relatesTo.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.relatesTo.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.relatesTo.code

Short replaces | transforms | signs | appends

Definition

The type of relationship that this composition has with anther composition or document.

Cardinality 1..1

DocumentRelationshipType (required)

The type of relationship between documents.

Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship.typeCode
cda: .relatedDocument.typeCode
fhirdocumentreference: DocumentReference.relatesTo.code

Composition.relatesTo.target[x]

Short Target of the relationship

Definition

The target composition/document of this relationship.

Cardinality 1..1

Type Identifier | Reference(Composition | CompositionUvIps)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .target[classCode="DOC", moodCode="EVN"].id
cda: .relatedDocument.id
fhirdocumentreference: DocumentReference.relatesTo.target

Composition.event

Short The clinical service(s) being documented

Definition

Cardinality 0..*

Summary True

Requirements

Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.

Comments

The event needs to be consistent with the type element, though can provide further information if desired.

Unordered, Open, by code(Value)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
cda: .documentationOf.serviceEvent
fhirdocumentreference: DocumentReference.event

Composition.event.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.event.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.event.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.event.code

Short Code(s) that apply to the event being documented

Definition

Cardinality 0..*

This list of codes represents the main clinical acts being documented.

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code
cda: .code
fhirdocumentreference: DocumentReference.event.code

Composition.event.period

Short The period covered by the documentation

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.

Cardinality 0..1

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
rim: .effectiveTime
cda: .effectiveTime
fhirdocumentreference: DocumentReference.event.period

Composition.event.detail

Short The event(s) being documented

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.

Cardinality 0..*

Type Reference(Resource)

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode="SUBJ"].target
cda: n/a

Composition.event:careProvisioningEvent

Short The care provisioning being documented

Definition

The provision of healthcare over a period of time this IPS is documenting.

Cardinality 0..1

Must Support True

Summary True

Requirements

Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.

Comments

The event needs to be consistent with the type element, though can provide further information if desired.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
cda: .documentationOf.serviceEvent
fhirdocumentreference: DocumentReference.event

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.event:careProvisioningEvent.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.event:careProvisioningEvent.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.event:careProvisioningEvent.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.event:careProvisioningEvent.code

Short Code(s) that apply to the event being documented

Definition

Cardinality 1..1

This list of codes represents the main clinical acts being documented.

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/v3-ActClass",
      "code": "PCPR"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code
cda: .code
fhirdocumentreference: DocumentReference.event.code

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.event:careProvisioningEvent.period

Short The period covered by the documentation

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.

Cardinality 0..1

Must Support True

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
rim: .effectiveTime
cda: .effectiveTime
fhirdocumentreference: DocumentReference.event.period

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.event:careProvisioningEvent.detail

Short The event(s) being documented

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.

Cardinality 0..*

Type Reference(Resource)

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode="SUBJ"].target
cda: n/a

Composition.section

Short Sections composing the IPS

Definition

The root of the sections that make up the IPS composition.

Cardinality 3..*

Must Support True

Unordered, Open, by code(Value)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section.entry

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(Resource)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionProblems

Short IPS Problems Section

Definition

The IPS problem section lists and describes clinical problems or conditions currently being monitored for the patient.

Cardinality 1..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()
ips-comp-1: Either section.entry or emptyReason are present
(entry.reference.exists() or emptyReason.exists())

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProblems.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionProblems.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionProblems.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionProblems.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionProblems.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProblems.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11450-4"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProblems.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionProblems.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionProblems.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProblems.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionProblems.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionProblems.entry

Short Clinical problems or conditions currently being monitored for the patient.

Definition

Cardinality 0..*

Type Reference(Condition | DocumentReference)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionProblems.entry:problem

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ConditionUvIps)

Must Support True

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHALL:able-to-populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProblems.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Must Support True

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProblems.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionAllergies

Short IPS Allergies and Intolerances Section

Definition

Cardinality 1..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()
ips-comp-1: Either section.entry or emptyReason are present
(entry.reference.exists() or emptyReason.exists())

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAllergies.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionAllergies.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionAllergies.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionAllergies.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionAllergies.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAllergies.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48765-2"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAllergies.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionAllergies.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionAllergies.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAllergies.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionAllergies.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionAllergies.entry

Short Relevant allergies or intolerances for that patient.

Definition

Cardinality 0..*

Type Reference(AllergyIntolerance | DocumentReference)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionAllergies.entry:allergyOrIntolerance

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(AllergyIntoleranceUvIps)

Must Support True

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHALL:able-to-populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAllergies.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Must Support True

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAllergies.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionMedications

Short IPS Medication Summary Section

Definition

The medication summary section contains a description of the patient's medications relevant for the scope of the patient summary. The actual content could depend on the jurisdiction, it could report:

the currently active medications;
the current and past medications considered relevant by the authoring GP;
the patient prescriptions or dispensations automatically extracted by a regional or a national EHR.

Cardinality 1..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()
ips-comp-1: Either section.entry or emptyReason are present
(entry.reference.exists() or emptyReason.exists())

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedications.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionMedications.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionMedications.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionMedications.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionMedications.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedications.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10160-0"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedications.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionMedications.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionMedications.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedications.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionMedications.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionMedications.entry

Short Medications relevant for the scope of the patient summary

Definition

Cardinality 0..*

Type Reference(DocumentReference | MedicationAdministration | MedicationDispense | MedicationRequest | MedicationStatement)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionMedications.entry:medicationStatementOrRequest

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(MedicationRequestIPS | MedicationStatementIPS)

Must Support True

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHALL:able-to-populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedications.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Must Support True

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedications.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionImmunizations

Short IPS Immunizations Section

Definition

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionImmunizations.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionImmunizations.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionImmunizations.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionImmunizations.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionImmunizations.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionImmunizations.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11369-6"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionImmunizations.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionImmunizations.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionImmunizations.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionImmunizations.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionImmunizations.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionImmunizations.entry

Short Patient's immunization status and pertinent history.

Definition

Cardinality 0..*

Type Reference(DocumentReference | Immunization)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionImmunizations.entry:immunization

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ImmunizationUvIps)

Must Support True

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionImmunizations.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionImmunizations.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionResults

Short IPS Results Section

Definition

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionResults.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionResults.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionResults.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionResults.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionResults.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionResults.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "30954-2"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionResults.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionResults.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionResults.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionResults.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionResults.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionResults.entry

Short Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient.

Definition

Cardinality 0..*

Type Reference(DiagnosticReport | DocumentReference | Observation)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Type), resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionResults.entry:results-observation-laboratory-pathology

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ObservationResultsLaboratoryPathologyUvIps)

Must Support True

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionResults.entry:results-observation-radiology

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ObservationResultsRadiologyUvIps)

Must Support True

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionResults.entry:results-diagnosticReport

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(DiagnosticReportUvIps)

Must Support True

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionResults.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionResults.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionProceduresHx

Short IPS History of Procedures Section

Definition

The History of Procedures Section contains a description of the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to:

Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section)
Therapeutic procedure: e.g. dialysis;
Surgical procedure: e.g. appendectomy

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProceduresHx.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionProceduresHx.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionProceduresHx.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionProceduresHx.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionProceduresHx.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProceduresHx.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47519-4"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProceduresHx.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionProceduresHx.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionProceduresHx.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProceduresHx.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionProceduresHx.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionProceduresHx.entry

Short Patient past procedures pertinent to the scope of this document.

Definition

It lists the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to:

Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section)
Therapeutic procedure: e.g. dialysis;
Surgical procedure: e.g. appendectomy. This entry shall be used to document that no information about past procedures is available, or that no relevant past procedures are known.

Cardinality 0..*

Type Reference(DocumentReference | Procedure)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionProceduresHx.entry:procedure

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ProcedureUvIps)

Must Support True

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionProceduresHx.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionProceduresHx.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionMedicalDevices

Short IPS Medical Devices Section

Definition

The medical devices section contains narrative text and coded entries describing the patient history of medical device use.

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedicalDevices.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionMedicalDevices.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionMedicalDevices.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionMedicalDevices.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionMedicalDevices.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedicalDevices.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "46264-8"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedicalDevices.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionMedicalDevices.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionMedicalDevices.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedicalDevices.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionMedicalDevices.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionMedicalDevices.entry

Short Patient history of medical device use.

Definition

Cardinality 0..*

Type Reference(DeviceUseStatement | DocumentReference)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionMedicalDevices.entry:deviceStatement

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(DeviceUseStatementUvIps)

Must Support True

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Obligations

Code	Actor
SHOULD:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionMedicalDevices.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionMedicalDevices.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionAdvanceDirectives

Short IPS Advance Directives Section

Definition

The advance directives section contains a narrative description of patient's advance directive.

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAdvanceDirectives.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionAdvanceDirectives.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionAdvanceDirectives.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionAdvanceDirectives.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionAdvanceDirectives.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAdvanceDirectives.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "42348-3"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAdvanceDirectives.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionAdvanceDirectives.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionAdvanceDirectives.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAdvanceDirectives.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionAdvanceDirectives.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionAdvanceDirectives.entry

Short Narrative description of the patient's advance directive.

Definition

Contains a narrative description or a Consent entry with information about the patient's advance directive.

Cardinality 0..*

Type Reference(Consent | DocumentReference)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionAdvanceDirectives.entry:advanceDirectivesConsent

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(Consent)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionAdvanceDirectives.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionAdvanceDirectives.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionAlerts

Short IPS Alerts Section

Definition

The alerts section flags potential concerns and/or dangers to/from the patient and may also include obstacles to care.

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAlerts.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionAlerts.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionAlerts.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionAlerts.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionAlerts.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAlerts.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "104605-1"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAlerts.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionAlerts.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionAlerts.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionAlerts.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionAlerts.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionAlerts.entry

Short Alert information.

Definition

Contains alert information to be communicated. May optionally reference other resources in IPS.

Cardinality 0..*

Type Reference(DocumentReference | Flag)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionAlerts.entry:alertsFlag

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(FlagAlertUvIps)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionAlerts.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionAlerts.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionFunctionalStatus

Short IPS Functional Status

Definition

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionFunctionalStatus.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionFunctionalStatus.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionFunctionalStatus.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionFunctionalStatus.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionFunctionalStatus.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionFunctionalStatus.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47420-5"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionFunctionalStatus.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionFunctionalStatus.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionFunctionalStatus.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionFunctionalStatus.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionFunctionalStatus.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionFunctionalStatus.entry

Short Optional entry used to represent disabilities and functional assessments

Definition

Cardinality 0..*

Type Reference(ClinicalImpression | Condition | DocumentReference)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionFunctionalStatus.entry:disability

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ConditionUvIps)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionFunctionalStatus.entry:functionalAssessment

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ClinicalImpression)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionFunctionalStatus.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionFunctionalStatus.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionPastProblems

Short IPS History of Past Problems Section

Definition

The History of Past Problems section contains a description of the conditions the patient suffered in the past but no longer tracked in the Problem List.

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPastProblems.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionPastProblems.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPastProblems.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPastProblems.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPastProblems.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPastProblems.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11348-0"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPastProblems.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionPastProblems.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionPastProblems.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPastProblems.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionPastProblems.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionPastProblems.entry

Short Conditions the patient suffered in the past.

Definition

It contains a description of the conditions the patient suffered in the past.

Cardinality 0..*

Type Reference(Condition | DocumentReference)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionPastProblems.entry:pastProblem

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ConditionUvIps)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionPastProblems.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionPastProblems.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionPregnancyHx

Short IPS History of Pregnancy Section

Definition

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPregnancyHx.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionPregnancyHx.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPregnancyHx.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPregnancyHx.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPregnancyHx.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPregnancyHx.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10162-6"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPregnancyHx.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionPregnancyHx.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionPregnancyHx.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPregnancyHx.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionPregnancyHx.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionPregnancyHx.entry

Short Current pregnancy status and, optionally, information about the outcome of earlier pregnancies.

Definition

It contains information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies.

Cardinality 0..*

Type Reference(DocumentReference | Observation)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionPregnancyHx.entry:pregnancyStatus

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ObservationPregnancyStatusUvIps)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionPregnancyHx.entry:pregnancyOutcome

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ObservationPregnancyOutcomeUvIps)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionPregnancyHx.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionPregnancyHx.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionPatientStory

Short IPS Patient Story Section

Definition

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPatientStory.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionPatientStory.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPatientStory.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPatientStory.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPatientStory.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPatientStory.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "81338-6"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPatientStory.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionPatientStory.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionPatientStory.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPatientStory.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionPatientStory.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionPatientStory.entry

Short Patient Story resources.

Definition

Contains resources to support the Patient Story. Instances of DocumentReference or any other suitable resource type may be used.

Cardinality 0..*

Type Reference(Resource)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionPatientStory.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionPatientStory.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionPlanOfCare

Short IPS Plan of Care Section

Definition

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPlanOfCare.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionPlanOfCare.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPlanOfCare.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPlanOfCare.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionPlanOfCare.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPlanOfCare.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "18776-5"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPlanOfCare.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionPlanOfCare.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionPlanOfCare.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionPlanOfCare.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionPlanOfCare.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionPlanOfCare.entry

Short Optional entry used to represent structured care plans

Definition

Cardinality 0..*

Type Reference(CarePlan | DocumentReference | ImmunizationRecommendation)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionPlanOfCare.entry:carePlan

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(CarePlan)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionPlanOfCare.entry:immunizationRecommendation

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(ImmunizationRecommendation)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionPlanOfCare.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionPlanOfCare.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionSocialHistory

Short IPS Social History Section

Definition

The social history section contains a description of the person’s Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionSocialHistory.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionSocialHistory.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionSocialHistory.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionSocialHistory.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionSocialHistory.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionSocialHistory.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "29762-2"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionSocialHistory.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionSocialHistory.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionSocialHistory.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionSocialHistory.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionSocialHistory.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionSocialHistory.entry

Short Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)

Definition

Description of the person’s Health related “lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)

Cardinality 0..*

Type Reference(DocumentReference | Observation)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionSocialHistory.entry:smokingTobaccoUse

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..1

Type Reference(ObservationTobaccoUseUvIps)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionSocialHistory.entry:alcoholUse

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..1

Type Reference(ObservationAlcoholUseUvIps)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionSocialHistory.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
cda: n/a

Composition.section:sectionSocialHistory.section

Short Nested Section

Definition

A nested sub-section within this section.

Cardinality 0..0

Type see (section)

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings

rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.section

Composition.section:sectionVitalSigns

Short IPS Vital Signs Section

Definition

Cardinality 0..1

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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()

Mappings

rim: n/a
rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
cda: .component.structuredBody.component.section

Obligations

Code	Actor
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionVitalSigns.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Composition.section:sectionVitalSigns.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionVitalSigns.extension:section-note

Short Additional notes that apply to the section (but not to specific resource).

Definition

Additional notes that apply to the section (but not to specific resource).

Cardinality 0..*

Alias extensions, user content

Comments

This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionVitalSigns.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

Composition.section:sectionVitalSigns.title

Short Label for section (e.g. for ToC)

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.

Cardinality 1..1

Must Support True

Alias header, label, caption

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ./title
cda: .title

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionVitalSigns.code

Short Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Cardinality 1..1

Classification of a section of a composition/document.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8716-3"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ./code
cda: .code

Obligations

Code	Actor
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionVitalSigns.author

Short Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality 0..*

Requirements

Identifies who is responsible for the content.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
cda: .author.assignedAuthor

Composition.section:sectionVitalSigns.focus

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

Definition

Cardinality 0..1

Type Reference(Resource)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
cda: .subject? (CDA did not differentiate between subject and focus)

Composition.section:sectionVitalSigns.text

Short Text summary of the section, for human interpretation

Definition

Cardinality 1..1

Must Support True

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: .text
cda: .text

Obligations

Code	Actor
SHALL:populate	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

Composition.section:sectionVitalSigns.mode

Short working | snapshot | changes

Definition

Cardinality 0..1

The processing mode that applies to this section.

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.class
rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
cda: n/a

Composition.section:sectionVitalSigns.orderedBy

Short Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Cardinality 0..1

What order applies to the items in the entry.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
cda: n/a

Composition.section:sectionVitalSigns.entry

Short Notable vital signs or physical findings.

Definition

Cardinality 0..*

Type Reference(DocumentReference | Observation)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Unordered, Open, by resolve()(Profile)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionVitalSigns.entry:vitalSign

Short A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality 0..*

Type Reference(observation-vitalsigns)

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
cda: .entry

Composition.section:sectionVitalSigns.emptyReason

Short Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality 0..1

If a section is empty, why it is empty.