API Name: put-health-plan

There are no (further) constraints on this element

Element id

CarePlan.meta

Short description

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.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

There are no (further) constraints on this element

Element id

CarePlan.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

Binding

IETF language tag

Binding extensions

maxValueSet	AllLanguages

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Element id

CarePlan.contained

Short description

n/a

Alternate names

inline resources, anonymous resources, contained resources

Definition

Grouping of contained resource

Comments

n/a

Data type

profile-HealthPlan-put-health-plan-goal

Slicing

Unordered, Closed, by $this(Type)

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

Goal

0..*

Element id

CarePlan.contained:Goal

Short description

n/a

Alternate names

inline resources, anonymous resources, contained resources

Definition

n/a

Comments

refer to below profile-HealthPlan-put-health-plan-goal for detailed goal spec

Data type

profile-HealthPlan-put-health-plan-goal

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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.exists() and ('#'+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(uri) = '#').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
rim: N/A
v2: GOL.1
rim: .outboundRelationship[typeCode<=OBJ].
w5: clinical.careprovision

Condition

0..*

profile-HealthPlan-conditionBase

Element id

CarePlan.contained:Condition

Short description

n/a

Alternate names

inline resources, anonymous resources, contained resources

Definition

n/a

Comments

refer to below profile-HealthPlan-conditionBase for detailed condition spec

Data type

profile-HealthPlan-conditionBase

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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.exists() and ('#'+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(uri) = '#').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()
con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission
abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-3: Condition.clinicalStatus SHOULD be present if verificationStatus is not entered-in-error and category is problem-list-item
verificationStatus.empty().not() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').exists().not() and category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.empty().not()

Mappings

rim: Entity. Role, or Act
rim: N/A
workflow: Event
sct-concept: < 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)
v2: PPR message
rim: Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]
w5: clinical.general

extension

1..*

There are no (further) constraints on this element

Element id

CarePlan.extension

Short description

n/a

Alternate names

extensions, user content

Definition

n/a

Comments

The extension is in the format of key/value pair, where the key is specified in 'url' attribute, and the value is specified in the 'value[Type]' attribute, the type can be Coding, String, Date or others depending on the definition specified in Data Type.

All the extension url is be prefixed with "http://ihis.sg/extension" and followed by friendly short name

Data type

http://ihis.sg/extension/performer

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

performer

1..1

Extension(Identifier)

There are no (further) constraints on this element

Element id

CarePlan.extension:performer

Short description

n/a

Alternate names

extensions, user content

Definition

n/a

Comments

n/a

Data type

Extension(Identifier)

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.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..0

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

Fixed value

http://ihis.sg/extension/performer

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.value[x]

Short description

n/a

Definition

Value of url

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.value[x].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..0

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.value[x].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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.value[x].use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

IdentifierUse (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.value[x].type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

Identifier Type Codes (extensible)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.value[x].system

Short description

n/a

Definition

Namespace of the clinician identifier to ensure global uniqueness, and indicate the type of clinician identifier specified in 'value' attribute. For the HealthierSG, fixed to namespace for prs (Professional Registration System)

Requirements

n/a

Comments

Fixed Value: "http://ihis.sg/identifier/prs"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/prs

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.value[x].value

Short description

n/a

Definition

Actual identifier registered to PRS

Comments

Sample Value: "M12345C"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
max-string-length-255: String length must not exceed 255 characters
$this.toString().length() <= 255

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.value[x].period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:performer.value[x].assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

visitMode

1..1

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode

Short description

n/a

Alternate names

extensions, user content

Definition

n/a

Comments

n/a

Data type

http://ihis.sg/extension/health-plan-visit-mode

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.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..0

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.url

Short description

n/a

Definition

The key of the extension element Visit mode code

Requirements

n/a

Comments

Fixed Value: "http://ihis.sg/extension/health-plan-visit-mode"

Data type

Fixed value

http://ihis.sg/extension/health-plan-visit-mode

Mappings

rim: N/A

value[x]

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x]

Short description

n/a

Definition

The value of the extension element

Requirements

n/a

Comments

n/a

Data type

hsg-health-plan-visit-mode (required)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].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..0

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

1..1

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].coding

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].coding.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..0

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].coding.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].coding.system

Short description

n/a

Definition

The terminology system of the coding

Requirements

n/a

Comments

Fixed Value: "http://ihis.sg/ValueSet/hsg-health-plan-visit-mode"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/ValueSet/hsg-health-plan-visit-mode

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].coding.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].coding.code

Short description

n/a

Definition

The code of the coding. It shall be one of the code defined in valueset Possible value: vm001, vm002, vm003

Requirements

n/a

Comments

Sample Value: "vm001"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].coding.display

Short description

n/a

Definition

The display of the coding. It shall be one of the code defined in valueset Possible value: Face-to-face, Video consult, Phone consult

Requirements

n/a

Comments

Sample Value: "Face-to-face"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:visitMode.value[x].text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

copyStatus

1..1

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus

Short description

n/a

Alternate names

extensions, user content

Definition

n/a

Comments

n/a

Data type

http://ihis.sg/extension/health-plan-copy-status

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.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..0

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.url

Short description

n/a

Definition

The key of the extension element Copy status code

Requirements

n/a

Comments

Fixed Value: "http://ihis.sg/extension/health-plan-copy-status"

Data type

Fixed value

http://ihis.sg/extension/health-plan-copy-status

Mappings

rim: N/A

value[x]

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x]

Short description

n/a

Definition

The value of the extension element

Requirements

n/a

Comments

n/a

Data type

hsg-health-plan-copy-status (required)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].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..0

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

1..1

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].coding

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].coding.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..0

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].coding.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].coding.system

Short description

n/a

Definition

The terminology system of the coding

Requirements

n/a

Comments

Fixed Value: "http://ihis.sg/ValueSet/hsg-health-plan-copy-status"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/ValueSet/hsg-health-plan-copy-status

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].coding.version

Short description

Version of the system - if relevant

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].coding.code

Short description

n/a

Definition

The code of the coding. It shall be one of the code defined in valueset Possible value: physical-copy-issued, physical-copy-not-issued

Requirements

n/a

Comments

Sample Value: "physical-copy-issued"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].coding.display

Short description

n/a

Definition

The display of the coding. It shall be one of the code defined in valueset Possible value: Physical Copy Issued, Physical Copy Not Issued

Requirements

n/a

Comments

Sample Value: "Physical Copy Issued"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.extension:copyStatus.value[x].text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

modifierExtension

?! C

0..0

There are no (further) constraints on this element

Element id

CarePlan.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

CarePlan.identifier

Short description

External Ids for this plan

Definition

Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Requirements

Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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: Request.identifier
w5: FiveWs.identifier
v2: PTH-3
rim: .id

instantiatesCanonical

0..0

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

There are no (further) constraints on this element

Element id

CarePlan.instantiatesCanonical

Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

Comments

Data type

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesCanonical
rim: .outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..0

There are no (further) constraints on this element

Element id

CarePlan.instantiatesUri

Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesUri
rim: .outboundRelationship[typeCode=DEFN].target

basedOn

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.basedOn

Short description

Fulfills CarePlan

Alternate names

fulfills

Definition

A care plan that is fulfilled in whole or in part by this care plan.

Requirements

Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.

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

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn

replaces

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.replaces

Short description

CarePlan replaced by this CarePlan

Alternate names

supersedes

Definition

Completed or terminated care plan whose function is taken by this new care plan.

Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.

Comments

The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.replaces

partOf

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.partOf

Short description

Part of referenced CarePlan

Definition

A larger care plan of which this particular care plan is a component or step.

Comments

Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

status

Σ ?!

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.status

Short description

n/a

Definition

Fixed to "active"

Requirements

n/a

Comments

Fixed to "active"

Data type

Binding

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

RequestStatus (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

active

Mappings

rim: n/a
workflow: Request.status {uses different ValueSet}
w5: FiveWs.status
v2: PTH-5
rim: .statusCode planned = new active = active completed = completed

intent

Σ ?!

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.intent

Short description

n/a

Definition

Care Plan intent. FHIR valueset of "Care Plan Intent".

Requirements

n/a

Comments

Fixed value: "plan"

Data type

Binding

Codes indicating the degree of authority/intentionality associated with a care plan.

CarePlanIntent (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

plan

Mappings

rim: n/a
workflow: Request.intent

category

1..1

There are no (further) constraints on this element

Element id

CarePlan.category

Short description

n/a

Definition

FHIR Value set "Care Plan Category". Customise codeset

Requirements

n/a

Comments

n/a

Data type

Binding

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.

CarePlanCategory (example)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class

0..0

There are no (further) constraints on this element

Element id

CarePlan.category.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..0

There are no (further) constraints on this element

Element id

CarePlan.category.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

1..1

CodingBinding

There are no (further) constraints on this element

Element id

CarePlan.category.coding

Short description

n/a

Definition

Grouping of coding

Requirements

n/a

Comments

n/a

Data type

hsg-care-plan-category (required)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

CarePlan.category.coding.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..0

There are no (further) constraints on this element

Element id

CarePlan.category.coding.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.category.coding.system

Short description

n/a

Definition

Identity of the terminology system

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/ValueSet/hsg-care-plan-category"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/ValueSet/hsg-care-plan-category

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

CarePlan.category.coding.version

Short description

Version of the system - if relevant

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

codeFixed Value

There are no (further) constraints on this element

Element id

CarePlan.category.coding.code

Short description

n/a

Definition

internal code for the terminology code

Requirements

n/a

Comments

Fixed Value : "pophealth-plan"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

pophealth-plan

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.category.coding.display

Short description

n/a

Definition

Description of the terminology code for display purpose

Requirements

n/a

Comments

Fixed value: "Pophealth Plan"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

CarePlan.category.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.category.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

title

0..0

There are no (further) constraints on this element

Element id

CarePlan.title

Short description

Human-friendly name for the care plan

Definition

Human-friendly name for the care plan.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

description

0..0

There are no (further) constraints on this element

Element id

CarePlan.description

Short description

Summary of nature of plan

Definition

A description of the scope and nature of the plan.

Requirements

Provides more detail than conveyed by category.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.what[x]

subject

Σ C

1..1

Reference(Patient)

There are no (further) constraints on this element

Element id

CarePlan.subject

Short description

n/a

Alternate names

patient

Definition

Reference to the patient in patient master to link this healthplan

Comments

n/a

Data type

Reference(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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: .participation[typeCode=PAT].role[classCode=PAT]
w5: FiveWs.subject

0..0

There are no (further) constraints on this element

Element id

CarePlan.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..0

There are no (further) constraints on this element

Element id

CarePlan.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

type

1..1

uriBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.subject.type

Short description

n/a

Definition

Indicate that the the identifier below is for Patient

Comments

Fixed Value : "Patient"

Data type

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Patient

Mappings

rim: n/a
rim: N/A

identifier

1..1

There are no (further) constraints on this element

Element id

CarePlan.subject.identifier

Short description

n/a

Definition

Grouping of identifier

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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

0..0

There are no (further) constraints on this element

Element id

CarePlan.subject.identifier.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..0

There are no (further) constraints on this element

Element id

CarePlan.subject.identifier.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.subject.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

IdentifierUse (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.subject.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Identifier Type Codes (extensible)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.subject.identifier.system

Short description

n/a

Definition

The namespace for the identifier patient nric

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/nric"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/nric

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

There are no (further) constraints on this element

Element id

CarePlan.subject.identifier.value

Short description

n/a

Definition

Value of patient nric

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.subject.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.subject.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..0

There are no (further) constraints on this element

Element id

CarePlan.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

encounter

Σ C

0..0

Reference(Encounter)

There are no (further) constraints on this element

Element id

CarePlan.encounter

Short description

Encounter created as part of

Definition

The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.context
w5: FiveWs.context
v2: Associated PV1
rim: .

period

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.period

Short description

n/a

Alternate names

timing

Definition

Period of this health plan

Requirements

n.a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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"]
workflow: Request.occurrence[x]
w5: FiveWs.planned
v2: GOL-7 / GOL-8
rim: .effectiveTime

0..0

There are no (further) constraints on this element

Element id

CarePlan.period.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..0

There are no (further) constraints on this element

Element id

CarePlan.period.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.period.start

Short description

n/a

Definition

Health plan start date.

Comments

Sample Value: "2022-01-01T10:30:01+08:00"

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

Σ C

0..1

There are no (further) constraints on this element

Element id

CarePlan.period.end

Short description

n/a

Definition

end date of health plan

Comments

Sample Value: "2022-01-01T10:30:01+08:00"

Meaning when missing

n/a

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: DR.2
rim: ./high

created

0..0

There are no (further) constraints on this element

Element id

CarePlan.created

Short description

Date record was first recorded

Alternate names

authoredOn

Definition

Represents when this particular CarePlan record was created in the system, which is often a system-generated date.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.authoredOn
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

author

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.author

Short description

n/a

Definition

Reference to PCP Organization thatmanages the health plan for the patient.

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.requester
w5: FiveWs.author

0..0

There are no (further) constraints on this element

Element id

CarePlan.author.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..0

There are no (further) constraints on this element

Element id

CarePlan.author.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.author.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

type

1..1

uriBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.author.type

Short description

n/a

Definition

Indicate that the the identifier below is for Organization

Comments

Fixed value : "Organization"

Data type

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Organization

Mappings

rim: n/a
rim: N/A

identifier

1..1

There are no (further) constraints on this element

Element id

CarePlan.author.identifier

Short description

n/a

Definition

Grouping of identifier

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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

0..0

There are no (further) constraints on this element

Element id

CarePlan.author.identifier.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..0

There are no (further) constraints on this element

Element id

CarePlan.author.identifier.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.author.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

IdentifierUse (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.author.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Identifier Type Codes (extensible)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.author.identifier.system

Short description

n/a

Definition

The namespace for the identifier hci code

Requirements

n/a

Comments

Use fixed Value : "http://ihis.sg/identifier/hci-code"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.author.identifier.value

Short description

n/a

Definition

Value of hci code

Comments

Sample Value : "HCI45678"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
max-string-length-9: String length must not exceed 9 characters
$this.toString().length() <= 9

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.author.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.author.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.author.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

contributor

0..0

There are no (further) constraints on this element

Element id

CarePlan.contributor

Short description

Who provided the content of the care plan

Definition

Identifies the individual(s) or organization who provided the contents of the care plan.

Comments

Collaborative care plans may have multiple contributors.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

careTeam

0..0

Reference(CareTeam)

There are no (further) constraints on this element

Element id

CarePlan.careTeam

Short description

Who's involved in plan?

Definition

Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

Requirements

Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.

Comments

Data type

Reference(CareTeam)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer {similar but does not entail CareTeam}
w5: FiveWs.actor

addresses

Σ C

0..*

Reference(Condition)

There are no (further) constraints on this element

Element id

CarePlan.addresses

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

Repeat the below reference element if there are multiple condition tags

Data type

Reference(Condition)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference
w5: FiveWs.why[x]
v2: PRB-4
rim: .actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]

0..0

There are no (further) constraints on this element

Element id

CarePlan.addresses.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..0

There are no (further) constraints on this element

Element id

CarePlan.addresses.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.addresses.reference

Short description

n/a

Definition

Reference to contained condition resource

Comments

Sample Value: "#f873f0480edf4e7da98c01be4c050710"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
max-string-length-255: String length must not exceed 255 characters
$this.toString().length() <= 255

Mappings

rim: n/a
rim: N/A

type

0..0

uriBinding

There are no (further) constraints on this element

Element id

CarePlan.addresses.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

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

CarePlan.addresses.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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

There are no (further) constraints on this element

Element id

CarePlan.addresses.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

supportingInfo

0..0

There are no (further) constraints on this element

Element id

CarePlan.supportingInfo

Short description

Information considered as part of plan

Definition

Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

Requirements

Identifies barriers and other considerations associated with the care plan.

Comments

Use "concern" to identify specific conditions addressed by the care plan.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.supportingInfo

goal

0..*

There are no (further) constraints on this element

Element id

CarePlan.goal

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: GOL.1
rim: .outboundRelationship[typeCode<=OBJ].

0..0

There are no (further) constraints on this element

Element id

CarePlan.goal.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..0

There are no (further) constraints on this element

Element id

CarePlan.goal.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.goal.reference

Short description

n/a

Definition

Reference to contained goal resource

Comments

Fixed Value: "#f873f0480edf4e7da98c01be4c05ad91"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
max-string-length-255: String length must not exceed 255 characters
$this.toString().length() <= 255

Mappings

rim: n/a
rim: N/A

type

0..0

uriBinding

There are no (further) constraints on this element

Element id

CarePlan.goal.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.

Comments

Data type

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

CarePlan.goal.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove 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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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

There are no (further) constraints on this element

Element id

CarePlan.goal.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

activity

1..*

There are no (further) constraints on this element

Element id

CarePlan.activity

Short description

Action to occur as part of plan

Definition

Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

Requirements

Allows systems to prompt for performance of planned activities, and validate plans against best practice.

Data type

Slicing

Unordered, Open, by detail.code.coding.system(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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpl-3: Provide a reference or detail, not both
detail.empty() or reference.empty()

Mappings

rim: n/a
workflow: {no mapping NOTE: This is a list of contained Request-Event tuples!}
rim: .outboundRelationship[typeCode=COMP].target

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

CarePlan.activity.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

outcomeCodeableConcept

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.outcomeCodeableConcept

Short description

Results of the activity

Definition

Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

Comments

Note that this should not duplicate the activity status (e.g. completed or in progress).

Data type

Binding

Identifies the results of the activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

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

outcomeReference

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity.outcomeReference

Short description

Appointment, Encounter, Procedure, etc.

Definition

Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).

Requirements

Links plan to resulting actions.

Comments

The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: {Event that is outcome of Request in activity.reference}
rim: .inboundRelationship[typeCode=FLFS].source

progress

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity.progress

Short description

Comments about the activity status/progress

Definition

Notes about the adherence/status/progress of the activity.

Requirements

Can be used to capture information about adherence, progress, concerns, etc.

Comments

This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Act
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

reference

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity.reference

Short description

Activity details defined in specific resource

Definition

The details of the proposed activity represented in a specific resource.

Requirements

Details in a form consistent with other applications and contexts of use.

Comments

Standard extension exists (resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference.
The goal should be visible when the resource referenced by CarePlan.activity.reference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should not point to this CarePlan using the "basedOn" element. i.e. Requests that are part of a CarePlan are not "based on" the CarePlan.

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: {Request that resulted in Event in activity.actionResulting}
rim: .outboundRelationship[typeCode=COMP].target

detail

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail

Short description

In-line definition of activity

Definition

A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

Requirements

Details in a simple form for generic care plan systems.

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.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

CarePlan.activity.detail.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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

CarePlan.activity.detail.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

kind

0..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.kind

Short description

Definition

A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.

Requirements

May determine what types of extensions are permitted.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .inboundRelationship[typeCode=COMP].source[classCode=LIST].code

instantiatesCanonical

0..*

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.instantiatesCanonical

Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

Data type

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesCanonical
rim: .outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.instantiatesUri

Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesUri
rim: .outboundRelationship[typeCode=DEFN].target

code

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.code

Short description

Detail type of activity

Definition

Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.

Requirements

Allows matching performed to planned as well as validation against protocols.

Comments

Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead.

Data type

ProcedureCodes(SNOMEDCT) (example)

Binding

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of 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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
v2: OBR-4 / RXE-2 / RXO-1 / RXD-2
rim: .code

reasonCode

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.reasonCode

Short description

Why activity should be done or why activity was prohibited

Definition

Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.

Data type

Binding

Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode

reasonReference

0..*

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.reasonReference

Short description

Why activity is needed

Definition

Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.

Comments

Conditions can be identified at the activity level that are not identified as reasons for the overall plan.

Data type

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference

goal

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.goal

Short description

Goals this activity relates to

Definition

Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

Requirements

So that participants know the link explicitly.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

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

status

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.status

Short description

Definition

Identifies what progress is being made for the specific activity.

Requirements

Indicates progress against the plan, whether the activity is still relevant for the plan.

Comments

Some aspects of status can be inferred based on the resources linked in actionTaken. Note that "status" is only as current as the plan was most recently updated.
The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the activity.

Data type

Binding

Codes that reflect the current state of a care plan activity within its overall life cycle.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.status
v2: ORC-5?
rim: .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted

statusReason

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.statusReason

Short description

Reason for current status

Definition

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

Comments

Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is 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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.statusReason

doNotPerform

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.doNotPerform

Short description

If true, activity is prohibiting action

Definition

If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.

Requirements

Captures intention to not do something that may have been previously typical.

Comments

This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.

Meaning when missing

If missing indicates that the described activity is one that should be engaged in when following the plan.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.doNotPerform
rim: actionNegationInd

scheduled[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.scheduled[x]

Short description

When activity is to occur

Definition

The period, timing or frequency upon which the described activity is to occur.

Requirements

Allows prompting for activities and detection of missed planned activities.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.occurrence[x]
v2: TQ1
rim: .effectiveTime

scheduledPeriod

There are no (further) constraints on this element

Data type

scheduledString

There are no (further) constraints on this element

Data type

scheduledTiming

There are no (further) constraints on this element

Data type

location

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.location

Short description

Where it should happen

Definition

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may identify a type of location.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBR-24(???!!)
rim: .participation[typeCode=LOC].role

performer

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.performer

Short description

Who will be responsible?

Definition

Identifies who's expected to be involved in the activity.

Requirements

Helps in planning of activity.

Comments

A performer MAY also be a participant in the care plan.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
v2: PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8
rim: .participation[typeCode=PFM]

product[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.product[x]

Short description

What is to be administered/supplied

Definition

Identifies the food, drug or other product to be consumed or supplied in the activity.

Binding

A product supplied or administered as part of a care plan activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: RXE-2 / RXO-1 / RXD-2
rim: .participation[typeCode=PRD].role

productCodeableConcept

There are no (further) constraints on this element

Data type

productReference

Reference(Medication | Substance)

There are no (further) constraints on this element

Data type

Reference(Medication | Substance)

dailyAmount

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.dailyAmount

Short description

How to consume/day?

Alternate names

daily dose

Definition

Identifies the quantity expected to be consumed in a given day.

Requirements

Allows rough dose checking.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-23 / RXE-19 / RXD-12
rim: .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity

quantity

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.quantity

Short description

How much to administer/supply/consume

Definition

Identifies the quantity expected to be supplied, administered or consumed by the subject.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
rim: .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity

description

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.description

Short description

Extra info describing activity to perform

Definition

This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: NTE?
rim: .text

recommended-next-check-in

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in

Short description

n/a

Definition

Represent next appointment date

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpl-3: Provide a reference or detail, not both
detail.empty() or reference.empty()

Mappings

rim: n/a
workflow: {no mapping NOTE: This is a list of contained Request-Event tuples!}
rim: .outboundRelationship[typeCode=COMP].target

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

outcomeCodeableConcept

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.outcomeCodeableConcept

Short description

Results of the activity

Definition

Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

Comments

Note that this should not duplicate the activity status (e.g. completed or in progress).

Data type

Binding

Identifies the results of the activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

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

outcomeReference

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.outcomeReference

Short description

Appointment, Encounter, Procedure, etc.

Definition

Requirements

Links plan to resulting actions.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: {Event that is outcome of Request in activity.reference}
rim: .inboundRelationship[typeCode=FLFS].source

progress

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.progress

Short description

Comments about the activity status/progress

Definition

Notes about the adherence/status/progress of the activity.

Requirements

Can be used to capture information about adherence, progress, concerns, etc.

Comments

This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Act
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

reference

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.reference

Short description

Activity details defined in specific resource

Definition

The details of the proposed activity represented in a specific resource.

Requirements

Details in a form consistent with other applications and contexts of use.

Comments

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: {Request that resulted in Event in activity.actionResulting}
rim: .outboundRelationship[typeCode=COMP].target

detail

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail

Short description

n/a

Definition

Grouping of detail

Requirements

n/a

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

kind

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.kind

Short description

n/a

Definition

Type of activity

Requirements

n/a

Comments

Fixed Value: "Appointment"

Data type

Binding

Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Appointment

Mappings

rim: n/a
rim: .inboundRelationship[typeCode=COMP].source[classCode=LIST].code

instantiatesCanonical

0..0

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.instantiatesCanonical

Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

Data type

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesCanonical
rim: .outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.instantiatesUri

Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesUri
rim: .outboundRelationship[typeCode=DEFN].target

code

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

hsg-healthplan-activity-type (required)

Binding

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of 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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
v2: OBR-4 / RXE-2 / RXO-1 / RXD-2
rim: .code

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.coding

Short description

n/a

Definition

Grouping of coding

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.coding.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.coding.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.coding.system

Short description

n/a

Definition

Identity of the terminology system

Requirements

n/a

Comments

Sample Value : "http://ihis.sg/ValueSet/hsg-healthplan-activity-type"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/ValueSet/hsg-healthplan-activity-type

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.coding.version

Short description

Version of the system - if relevant

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.coding.code

Short description

n/a

Definition

The code of the coding

Requirements

n/a

Comments

Sample Value : "recommended-next-check-in"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.coding.display

Short description

n/a

Definition

Display value of the coding

Requirements

n/a

Comments

Sample Value : "Recommended Next Check-in"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.code.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

reasonCode

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.reasonCode

Short description

Why activity should be done or why activity was prohibited

Definition

Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.

Data type

Binding

Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode

reasonReference

0..0

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.reasonReference

Short description

Why activity is needed

Definition

Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.

Comments

Conditions can be identified at the activity level that are not identified as reasons for the overall plan.

Data type

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference

goal

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.goal

Short description

Goals this activity relates to

Definition

Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

Requirements

So that participants know the link explicitly.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

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

status

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.status

Short description

n/a

Definition

status of the activity

Requirements

n/a

Comments

Fixed Value: "scheduled"

Data type

Binding

Codes that reflect the current state of a care plan activity within its overall life cycle.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

scheduled

Mappings

rim: n/a
workflow: Request.status
v2: ORC-5?
rim: .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted

statusReason

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.statusReason

Short description

Reason for current status

Definition

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

Comments

Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is 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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.statusReason

doNotPerform

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.doNotPerform

Short description

If true, activity is prohibiting action

Definition

Requirements

Captures intention to not do something that may have been previously typical.

Comments

This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.

Meaning when missing

If missing indicates that the described activity is one that should be engaged in when following the plan.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.doNotPerform
rim: actionNegationInd

scheduled[x]

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.scheduled[x]

Short description

n/a

Definition

When activity is to occur Next visit date is mapped as activity detail

Requirements

Format: YYYY-MM

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.occurrence[x]
v2: TQ1
rim: .effectiveTime

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.scheduled[x].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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.scheduled[x].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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.scheduled[x].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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

event

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.scheduled[x].event

Short description

n/a

Definition

When the event occur

Requirements

n/a

Comments

Sample Value: "2023-10"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
healthplan-scheduledTiming: Expected date format is YYYY-MM.
$this.toString().matches('^\\d{4}-(0[1-9]|1[0-2])$')

Mappings

rim: n/a
rim: QLIST<TS>

repeat

Σ C

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.scheduled[x].repeat

Short description

When the event is to occur

Definition

A set of rules that describe when the event is scheduled.

Requirements

Many timing schedules are determined by regular repetitions.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-5: period SHALL be a non-negative value
period.exists() implies period >= 0
tim-6: If there's a periodMax, there must be a period
periodMax.empty() or period.exists()
tim-7: If there's a durationMax, there must be a duration
durationMax.empty() or duration.exists()
tim-8: If there's a countMax, there must be a count
countMax.empty() or count.exists()
tim-1: if there's a duration, there needs to be duration units
duration.empty() or durationUnit.exists()
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
timeOfDay.empty() or when.empty()
tim-2: if there's a period, there needs to be period units
period.empty() or periodUnit.exists()
tim-4: duration SHALL be a non-negative value
duration.exists() implies duration >= 0

Mappings

rim: n/a
rim: Implies PIVL or EIVL

code

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.scheduled[x].code

Short description

BID | TID | QID | AM | PM | QD | QOD | +

Definition

A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).

Comments

BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).

Data type

TimingAbbreviation (preferred)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

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

location

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.location

Short description

Where it should happen

Definition

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may identify a type of location.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBR-24(???!!)
rim: .participation[typeCode=LOC].role

performer

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.performer

Short description

Who will be responsible?

Definition

Identifies who's expected to be involved in the activity.

Requirements

Helps in planning of activity.

Comments

A performer MAY also be a participant in the care plan.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
v2: PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8
rim: .participation[typeCode=PFM]

product[x]

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.product[x]

Short description

What is to be administered/supplied

Definition

Identifies the food, drug or other product to be consumed or supplied in the activity.

Binding

A product supplied or administered as part of a care plan activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: RXE-2 / RXO-1 / RXD-2
rim: .participation[typeCode=PRD].role

dailyAmount

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.dailyAmount

Short description

How to consume/day?

Alternate names

daily dose

Definition

Identifies the quantity expected to be consumed in a given day.

Requirements

Allows rough dose checking.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-23 / RXE-19 / RXD-12
rim: .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity

quantity

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.quantity

Short description

How much to administer/supply/consume

Definition

Identifies the quantity expected to be supplied, administered or consumed by the subject.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
rim: .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity

description

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:recommended-next-check-in.detail.description

Short description

Extra info describing activity to perform

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: NTE?
rim: .text

Diet

0..8

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet

Short description

n/a

Definition

Represent action plan in health plan Diet

Requirements

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpl-3: Provide a reference or detail, not both
detail.empty() or reference.empty()

Mappings

rim: n/a
workflow: {no mapping NOTE: This is a list of contained Request-Event tuples!}
rim: .outboundRelationship[typeCode=COMP].target

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

outcomeCodeableConcept

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept

Short description

n/a

Definition

Represent category of action plan

Comments

n/a

Data type

Binding

Identifies the results of the activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

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

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

1..1

CodingBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.coding

Short description

n/a

Definition

Grouping of coding

Requirements

n/a

Comments

n/a

Data type

hsg-action-plan-category (required)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.coding.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.coding.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.coding.system

Short description

n/a

Definition

The terminology system of the coding

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/ValueSet/hsg-action-plan-category"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/ValueSet/hsg-action-plan-category

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.coding.version

Short description

Version of the system - if relevant

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

codeFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.coding.code

Short description

n/a

Definition

The code of the coding

Requirements

n/a

Comments

Sample Value : "AP1"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

AP1

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.coding.display

Short description

n/a

Definition

Display value of the coding

Requirements

n/a

Comments

Sample Value : "Diet"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeCodeableConcept.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

outcomeReference

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.outcomeReference

Short description

Appointment, Encounter, Procedure, etc.

Definition

Requirements

Links plan to resulting actions.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: {Event that is outcome of Request in activity.reference}
rim: .inboundRelationship[typeCode=FLFS].source

progress

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.progress

Short description

Comments about the activity status/progress

Definition

Notes about the adherence/status/progress of the activity.

Requirements

Can be used to capture information about adherence, progress, concerns, etc.

Comments

This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Act
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

reference

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.reference

Short description

Activity details defined in specific resource

Definition

The details of the proposed activity represented in a specific resource.

Requirements

Details in a form consistent with other applications and contexts of use.

Comments

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: {Request that resulted in Event in activity.actionResulting}
rim: .outboundRelationship[typeCode=COMP].target

detail

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail

Short description

n/a

Definition

Grouping of detail

Requirements

n/a

Comments

n/a

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

kind

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.kind

Short description

n/a

Definition

Type of activity

Requirements

n/a

Comments

Fixed Value: "ServiceRequest"

Data type

Binding

Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

ServiceRequest

Mappings

rim: n/a
rim: .inboundRelationship[typeCode=COMP].source[classCode=LIST].code

instantiatesCanonical

0..0

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.instantiatesCanonical

Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

Data type

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesCanonical
rim: .outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.instantiatesUri

Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesUri
rim: .outboundRelationship[typeCode=DEFN].target

code

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code

Short description

n/a

Definition

Detail type of activity

Requirements

n/a

Comments

n/a

Data type

hsg-action-plan-diet-item (required)

Binding

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of 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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
v2: OBR-4 / RXE-2 / RXO-1 / RXD-2
rim: .code

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.coding

Short description

n/a

Definition

Grouping of coding

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.coding.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.coding.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.coding.system

Short description

n/a

Definition

The terminology system of the coding

Requirements

n/a

Comments

Sample Value : "http://ihis.sg/ValueSet/hsg-action-plan-diet-item"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/ValueSet/hsg-action-plan-diet-item

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.coding.version

Short description

Version of the system - if relevant

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.coding.code

Short description

n/a

Definition

The code of the coding

Requirements

n/a

Comments

Sample Value : "DI001"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
healthplan-diet: AP1 allowed values: ('DI001' | 'DI002' | 'DI003' | 'DI004' | 'DI005' | 'DI006' | 'DI007' | 'DI008')
($this in ('DI001' | 'DI002' | 'DI003' | 'DI004' | 'DI005' | 'DI006' | 'DI007' | 'DI008'))

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.coding.display

Short description

n/a

Definition

Display value of the coding

Requirements

n/a

Comments

Sample Value : "Limit sodium intake"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.code.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

reasonCode

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.reasonCode

Short description

Why activity should be done or why activity was prohibited

Definition

Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.

Data type

Binding

Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode

reasonReference

0..0

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.reasonReference

Short description

Why activity is needed

Definition

Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.

Comments

Conditions can be identified at the activity level that are not identified as reasons for the overall plan.

Data type

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference

goal

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.goal

Short description

Goals this activity relates to

Definition

Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

Requirements

So that participants know the link explicitly.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

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

status

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.status

Short description

n/a

Definition

status of the activity

Requirements

n/a

Comments

Fixed Value: "scheduled"

Data type

Binding

Codes that reflect the current state of a care plan activity within its overall life cycle.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

scheduled

Mappings

rim: n/a
workflow: Request.status
v2: ORC-5?
rim: .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted

statusReason

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.statusReason

Short description

Reason for current status

Definition

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

Comments

Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is 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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.statusReason

doNotPerform

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.doNotPerform

Short description

If true, activity is prohibiting action

Definition

Requirements

Captures intention to not do something that may have been previously typical.

Comments

This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.

Meaning when missing

If missing indicates that the described activity is one that should be engaged in when following the plan.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.doNotPerform
rim: actionNegationInd

scheduled[x]

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.scheduled[x]

Short description

When activity is to occur

Definition

The period, timing or frequency upon which the described activity is to occur.

Requirements

Allows prompting for activities and detection of missed planned activities.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.occurrence[x]
v2: TQ1
rim: .effectiveTime

location

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.location

Short description

Where it should happen

Definition

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may identify a type of location.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBR-24(???!!)
rim: .participation[typeCode=LOC].role

performer

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.performer

Short description

Who will be responsible?

Definition

Identifies who's expected to be involved in the activity.

Requirements

Helps in planning of activity.

Comments

A performer MAY also be a participant in the care plan.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
v2: PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8
rim: .participation[typeCode=PFM]

product[x]

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.product[x]

Short description

What is to be administered/supplied

Definition

Identifies the food, drug or other product to be consumed or supplied in the activity.

Binding

A product supplied or administered as part of a care plan activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: RXE-2 / RXO-1 / RXD-2
rim: .participation[typeCode=PRD].role

dailyAmount

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.dailyAmount

Short description

How to consume/day?

Alternate names

daily dose

Definition

Identifies the quantity expected to be consumed in a given day.

Requirements

Allows rough dose checking.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-23 / RXE-19 / RXD-12
rim: .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity

quantity

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.quantity

Short description

How much to administer/supply/consume

Definition

Identifies the quantity expected to be supplied, administered or consumed by the subject.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
rim: .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity

description

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Diet.detail.description

Short description

n/a

Definition

Extra info describing activity to perform

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: NTE?
rim: .text

Vaccination

0..9

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination

Short description

n/a

Definition

Represent action plan in health plan Vaccination

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpl-3: Provide a reference or detail, not both
detail.empty() or reference.empty()

Mappings

rim: n/a
workflow: {no mapping NOTE: This is a list of contained Request-Event tuples!}
rim: .outboundRelationship[typeCode=COMP].target

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

outcomeCodeableConcept

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept

Short description

n/a

Definition

Represent category of action plan

Comments

n/a

Data type

Binding

Identifies the results of the activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

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

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

1..1

CodingBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.coding

Short description

n/a

Definition

Grouping of coding

Requirements

n/a

Comments

n/a

Data type

hsg-action-plan-category (required)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.coding.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.coding.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.coding.system

Short description

n/a

Definition

The terminology system of the coding

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/ValueSet/hsg-action-plan-category"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/ValueSet/hsg-action-plan-category

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.coding.version

Short description

Version of the system - if relevant

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

codeFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.coding.code

Short description

n/a

Definition

The code of the coding

Requirements

n/a

Comments

Sample Value : "AP2"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

AP2

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.coding.display

Short description

n/a

Definition

Display value of the coding

Requirements

n/a

Comments

Sample Value : "Vaccination"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeCodeableConcept.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

outcomeReference

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.outcomeReference

Short description

Appointment, Encounter, Procedure, etc.

Definition

Requirements

Links plan to resulting actions.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: {Event that is outcome of Request in activity.reference}
rim: .inboundRelationship[typeCode=FLFS].source

progress

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.progress

Short description

Comments about the activity status/progress

Definition

Notes about the adherence/status/progress of the activity.

Requirements

Can be used to capture information about adherence, progress, concerns, etc.

Comments

This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Act
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

reference

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.reference

Short description

Activity details defined in specific resource

Definition

The details of the proposed activity represented in a specific resource.

Requirements

Details in a form consistent with other applications and contexts of use.

Comments

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: {Request that resulted in Event in activity.actionResulting}
rim: .outboundRelationship[typeCode=COMP].target

detail

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail

Short description

n/a

Definition

Grouping of detail

Requirements

n/a

Comments

n/a

Data type

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.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..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.extension

Short description

n/a

Alternate names

extensions, user content

Definition

Additional data element required by action plan

Comments

Applicable for vaccination, not applicable for diet.

Mandatory for vaccination - "Influenza (INF)" if scheduledTiming (repeat annually) is NOT submitted -Mandatory for the rest of the vaccinations if the vaccination activity is submitted.

Data type

http://ihis.sg/extension/dueDate

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

vaccinationExtension

0..1

Extension(date)

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.extension:vaccinationExtension

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(date)

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.extension:vaccinationExtension.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.extension:vaccinationExtension.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.extension:vaccinationExtension.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Fixed value

http://ihis.sg/extension/dueDate

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.extension:vaccinationExtension.value[x]

Short description

n/a

Definition

n/a

Comments

Sample Value: "2025-1-1"

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

valueDate

date

There are no (further) constraints on this element

Data type

date

modifierExtension

Σ ?! C

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

kind

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.kind

Short description

n/a

Definition

Type of activity

Requirements

n/a

Comments

Fixed Value: "ServiceRequest"

Data type

Binding

Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

ServiceRequest

Mappings

rim: n/a
rim: .inboundRelationship[typeCode=COMP].source[classCode=LIST].code

instantiatesCanonical

0..0

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.instantiatesCanonical

Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

Data type

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesCanonical
rim: .outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.instantiatesUri

Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.instantiatesUri
rim: .outboundRelationship[typeCode=DEFN].target

code

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code

Short description

n/a

Definition

Detail type of activity

Requirements

n/a

Comments

n/a

Data type

hsg-action-plan-vaccination-item (required)

Binding

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of 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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
v2: OBR-4 / RXE-2 / RXO-1 / RXD-2
rim: .code

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.coding

Short description

n/a

Definition

Grouping of coding

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.coding.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.coding.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.coding.system

Short description

n/a

Definition

The terminology system of the coding

Requirements

n/a

Comments

Sample Value : "http://ihis.sg/ValueSet/hsg-action-plan-vaccination-item"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/ValueSet/hsg-action-plan-vaccination-item

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.coding.version

Short description

Version of the system - if relevant

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.coding.code

Short description

n/a

Definition

The code of the coding

Requirements

n/a

Comments

Sample Value : "A-Tdap"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
healthplan-vaccination: AP2 allowed values: ('A-INF' | 'A-PNC' | 'A-PPSV' | 'A-Tdap' | 'A-HEPB' | 'A-MMR' | 'A-CPOX' | 'A-PCV20' | 'A-HZVRC')
($this in ('A-INF' | 'A-PNC' | 'A-PPSV' | 'A-Tdap' | 'A-HEPB' | 'A-MMR' | 'A-CPOX' | 'A-PCV20' | 'A-HZVRC'))

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.coding.display

Short description

n/a

Definition

Display value of the coding

Requirements

n/a

Comments

Sample Value : "Tetanus, reduced diphtheria & acellular pertussis (Tdap)"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.code.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

reasonCode

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.reasonCode

Short description

Why activity should be done or why activity was prohibited

Definition

Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.

Data type

Binding

Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode

reasonReference

0..0

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.reasonReference

Short description

Why activity is needed

Definition

Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.

Comments

Conditions can be identified at the activity level that are not identified as reasons for the overall plan.

Data type

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference

goal

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.goal

Short description

Goals this activity relates to

Definition

Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

Requirements

So that participants know the link explicitly.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

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

status

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.status

Short description

n/a

Definition

status of the activity

Requirements

n/a

Comments

Fixed Value: "scheduled"

Data type

Binding

Codes that reflect the current state of a care plan activity within its overall life cycle.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

scheduled

Mappings

rim: n/a
workflow: Request.status
v2: ORC-5?
rim: .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted

statusReason

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.statusReason

Short description

Reason for current status

Definition

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

Comments

Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is 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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.statusReason

doNotPerform

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.doNotPerform

Short description

If true, activity is prohibiting action

Definition

Requirements

Captures intention to not do something that may have been previously typical.

Comments

This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.

Meaning when missing

If missing indicates that the described activity is one that should be engaged in when following the plan.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.doNotPerform
rim: actionNegationInd

scheduled[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]

Short description

n/a

Definition

When the event occur

Requirements

n/a

Comments

Only applicable for "Influenza (INF)" under vaccination Sample value "1, 1, a" means occur 1 time per year (repeat annually) 'scheduledTiming' should not be submitted if it does not need to be repeated annually

Mandatory for "Influenza (INF)" if extension/dueDate (Suggested Next Dose Date) is NOT submitted

Slicing

Unordered, Open, by $this(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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.occurrence[x]
v2: TQ1
rim: .effectiveTime

scheduledPeriod

There are no (further) constraints on this element

Data type

scheduledString

There are no (further) constraints on this element

Data type

scheduledTiming

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming

Short description

n/a

Definition

When the event occur

Requirements

n/a

Comments

Mandatory for "Influenza (INF)" if extension/dueDate (Suggested Next Dose Date) is NOT submitted

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
workflow: Request.occurrence[x]
v2: TQ1
rim: .effectiveTime

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

event

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.event

Short description

When the event occurs

Definition

Identifies specific times when the event occurs.

Requirements

In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: QLIST<TS>

repeat

Σ C

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat

Short description

n/a

Definition

How the event repeat

Requirements

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-5: period SHALL be a non-negative value
period.exists() implies period >= 0
tim-6: If there's a periodMax, there must be a period
periodMax.empty() or period.exists()
tim-7: If there's a durationMax, there must be a duration
durationMax.empty() or duration.exists()
tim-8: If there's a countMax, there must be a count
countMax.empty() or count.exists()
tim-1: if there's a duration, there needs to be duration units
duration.empty() or durationUnit.exists()
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
timeOfDay.empty() or when.empty()
tim-2: if there's a period, there needs to be period units
period.empty() or periodUnit.exists()
tim-4: duration SHALL be a non-negative value
duration.exists() implies duration >= 0

Mappings

rim: n/a
rim: Implies PIVL or EIVL

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.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..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

bounds[x]

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.bounds[x]

Short description

Length/Range of lengths, or (Start and/or end) limits

Definition

Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: IVL(TS) used in a QSI

count

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.count

Short description

Number of times to repeat

Definition

A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.

Requirements

Repetitions may be limited by end time or total occurrences.

Comments

If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: PIVL.count

countMax

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.countMax

Short description

Maximum number of times to repeat

Definition

If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.

Comments

32 bit number; for values larger than this, use decimal

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: PIVL.count

duration

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.duration

Short description

How long when it happens

Definition

How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.

Requirements

Some activities are not instantaneous and need to be maintained for a period of time.

Comments

For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: PIVL.phase

durationMax

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.durationMax

Short description

How long when it happens (Max)

Definition

If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.

Requirements

Some activities are not instantaneous and need to be maintained for a period of time.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: PIVL.phase

durationUnit

0..0

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.durationUnit

Short description

s | min | h | d | wk | mo | a - unit of time (UCUM)

Definition

The units of time for the duration, in UCUM units.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

UnitsOfTime (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: PIVL.phase.unit

frequency

1..1

positiveIntFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.frequency

Short description

n/a

Definition

Event occurs frequency times per period

Comments

Sample Value : 1

Meaning when missing

If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Mappings

rim: n/a
rim: PIVL.phase

frequencyMax

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.frequencyMax

Short description

Event occurs up to frequencyMax times per period

Definition

If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

Comments

32 bit number; for values larger than this, use decimal

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: PIVL.phase

period

1..1

decimalFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.period

Short description

n/a

Definition

Number of period

Comments

Sample Value : 1

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

1.0

Mappings

rim: n/a
rim: PIVL.phase

periodMax

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.periodMax

Short description

Upper limit of period (3-4 hours)

Definition

If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.

Comments

Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: PIVL.phase

periodUnit

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.periodUnit

Short description

n/a

Definition

unit of period (a - annual)

Comments

Sample Value : "a"

Data type

Binding

UnitsOfTime (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Mappings

rim: n/a
rim: PIVL.phase.unit

dayOfWeek

0..0

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.dayOfWeek

Short description

mon | tue | wed | thu | fri | sat | sun

Definition

If one or more days of week is provided, then the action happens only on the specified day(s).

Comments

If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.

Data type

Binding

DaysOfWeek (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

timeOfDay

0..0

time

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.timeOfDay

Short description

Time of day for action

Definition

Specified time of day for action to take place.

Comments

When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.

Data type

time

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

when

0..0

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.when

Short description

Code for time period of occurrence

Definition

An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

Requirements

Timings are frequently determined by occurrences such as waking, eating and sleep.

Comments

When more than one event is listed, the event is tied to the union of the specified events.

Data type

Binding

EventTiming (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: EIVL.event

offset

0..0

unsignedInt

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.offset

Short description

Minutes from event (before or after)

Definition

The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.

Comments

32 bit number; for values larger than this, use decimal

Data type

unsignedInt

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: EIVL.offset

code

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.code

Short description

BID | TID | QID | AM | PM | QD | QOD | +

Definition

Comments

Data type

TimingAbbreviation (preferred)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

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

location

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.location

Short description

Where it should happen

Definition

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may identify a type of location.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBR-24(???!!)
rim: .participation[typeCode=LOC].role

performer

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.performer

Short description

Who will be responsible?

Definition

Identifies who's expected to be involved in the activity.

Requirements

Helps in planning of activity.

Comments

A performer MAY also be a participant in the care plan.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
v2: PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8
rim: .participation[typeCode=PFM]

product[x]

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.product[x]

Short description

What is to be administered/supplied

Definition

Identifies the food, drug or other product to be consumed or supplied in the activity.

Binding

A product supplied or administered as part of a care plan activity.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: RXE-2 / RXO-1 / RXD-2
rim: .participation[typeCode=PRD].role

dailyAmount

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.dailyAmount

Short description

How to consume/day?

Alternate names

daily dose

Definition

Identifies the quantity expected to be consumed in a given day.

Requirements

Allows rough dose checking.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-23 / RXE-19 / RXD-12
rim: .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity

quantity

0..0

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.quantity

Short description

How much to administer/supply/consume

Definition

Identifies the quantity expected to be supplied, administered or consumed by the subject.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
rim: .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity

description

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity:Vaccination.detail.description

Short description

n/a

Definition

Extra info describing activity to perform

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: NTE?
rim: .text

note

0..2

There are no (further) constraints on this element

Element id

CarePlan.note

Short description

n/a

Definition

To store the record of discussion for the health plan, or one thing to start working on today.

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Request.note
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

0..0

There are no (further) constraints on this element

Element id

CarePlan.note.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

1..*

There are no (further) constraints on this element

Element id

CarePlan.note.extension

Short description

n/a

Alternate names

extensions, user content

Definition

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

noteExtension

1..1

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension

Short description

n/a

Alternate names

extensions, user content

Definition

n/a

Comments

n/a

Data type

http://ihis.sg/extension/health-plan-note-type

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.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..0

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Fixed value

http://ihis.sg/extension/health-plan-note-type

Mappings

rim: N/A

value[x]

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x]

Short description

n/a

Definition

To distinguish health plan note or one thing to start working on today

Comments

n/a

Data type

hsg-health-plan-note-type (required)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].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..0

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

1..1

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].coding

Short description

n/a

Definition

Grouping of coding

Requirements

n/a

Comments

n/a

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].coding.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..0

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].coding.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].coding.system

Short description

n/a

Definition

The terminology system of the coding

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/ValueSet/hsg-health-plan-note-type"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/ValueSet/hsg-health-plan-note-type

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].coding.version

Short description

Version of the system - if relevant

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].coding.code

Short description

n/a

Definition

The code of the coding

Requirements

n/a

Comments

Sample Value : "health-plan-discussion-note"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].coding.display

Short description

n/a

Definition

Display value of the coding

Requirements

n/a

Comments

Sample Value : "Record of Discussion"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

CarePlan.note.extension:noteExtension.value[x].text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

author[x]

0..0

There are no (further) constraints on this element

Element id

CarePlan.note.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

time

0..0

There are no (further) constraints on this element

Element id

CarePlan.note.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

profile-HealthPlan-goalBase

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

Σ C

1..1

markdown

There are no (further) constraints on this element

Element id

CarePlan.note.text

Short description

n/a

Definition

The annotation - text content (as markdown)

Comments

Sample Value: "Test note", max 5000 characters allowed

Data type

markdown

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
health-plan-note: Value must be between 1 to 5000 characters
$this.length() > 0 and $this.length() <= 5000

Mappings

rim: n/a
v2: N/A
rim: Act.text

condition

0..0

Reference

There are no (further) constraints on this element

Element id

CarePlan.condition

Short description

A reference from one resource to another

Definition

A reference from one resource to another.

Comments

Data type

Reference

Allowed aggregation:contained

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Note:

The "subject" element is a mandatory field in the FHIR Goal resource, and its cardinality (1..1) cannot be modified. This field will be populated automatically by the HSAR backend, so clients do not need to supply the "subject" value in the request.
Please include the id element under the Goal resource.
For the detailed structures of detailQuantity, detailRatio, dueDate, and dueDuration within the Goal resource, please refer to the profile link for full specifications.

profile-HealthPlan-put-health-plan-goal (Goal)

There are no (further) constraints on this element

Element id

Goal

Short description

n/a

Definition

n/a

Comments

n/a

Data type

profile-HealthPlan-goalBase

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.exists() and ('#'+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(uri) = '#').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
v2: GOL.1
rim: .outboundRelationship[typeCode<=OBJ].
w5: clinical.careprovision

1..1

There are no (further) constraints on this element

Element id

Goal.id

Short description

n/a

Definition

The logical id of the resource, SOE to generate a guid without hyphen

Comments

Sample Value: "f873f0480edf4e7da98c01be4c05ad91"

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

There are no (further) constraints on this element

Element id

Goal.meta

Short description

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.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

Goal.meta.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..0

There are no (further) constraints on this element

Element id

Goal.meta.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

versionId

0..0

There are no (further) constraints on this element

Element id

Goal.meta.versionId

Short description

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.

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.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

lastUpdated

0..0

instant

There are no (further) constraints on this element

Element id

Goal.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

instant

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

source

0..0

There are no (further) constraints on this element

Element id

Goal.meta.source

Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

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.

Data type

canonical(StructureDefinition)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

profile

0..*

There are no (further) constraints on this element

Element id

Goal.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

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.

Data type

canonical(StructureDefinition)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

security

0..0

CodingBinding

There are no (further) constraints on this element

Element id

Goal.meta.security

Short description

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.

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.

Data type

All Security Labels (extensible)

Binding

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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

tag

0..0

There are no (further) constraints on this element

Element id

Goal.meta.tag

Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

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.

Data type

Binding

CommonTags (example)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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

implicitRules

Σ ?!

0..0

There are no (further) constraints on this element

Element id

Goal.implicitRules

Short description

A set of rules under which this content was created

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Goal.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

IETF language tag

Binding extensions

maxValueSet	AllLanguages

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

There are no (further) constraints on this element

Element id

Goal.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

There are no (further) constraints on this element

Element id

Goal.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

There are no (further) constraints on this element

Element id

Goal.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. 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.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

Goal.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Goal.identifier

Short description

External Ids for this goal

Definition

Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Requirements

Allows identification of the goal as it is known by various participating systems and in a way that remains consistent across servers.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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
w5: FiveWs.identifier
rim: .id

lifecycleStatus

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Goal.lifecycleStatus

Short description

n/a

Definition

The status of this goal

Requirements

n/a

Comments

Fixed Value: "active"

Any changes made to healthplan will create a new version with goal status active.

Data type

GoalLifecycleStatus (required)

Binding

Codes that reflect the current state of a goal and whether the goal is still being targeted.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
v2: GOL-18-goal life cycle status
rim: .statusCode in-progress = active (classCode = OBJ) cancelled = aborted

achievementStatus

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Goal.achievementStatus

Short description

Definition

Describes the progression, or lack thereof, towards the goal against the target.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

GoalAchievementStatus (preferred)

Binding

Indicates the progression, or lack thereof, towards the goal against the target.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .statusCode achieved = complete sustaining = active

meta

0..1

There are no (further) constraints on this element

Element id

Condition.meta

Short description

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.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

There are no (further) constraints on this element

Element id

Condition.implicitRules

Short description

A set of rules under which this content was created

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Condition.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

IETF language tag

Binding extensions

maxValueSet	AllLanguages

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

There are no (further) constraints on this element

Element id

Condition.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

There are no (further) constraints on this element

Element id

Condition.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

There are no (further) constraints on this element

Element id

Condition.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

Condition.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Condition.identifier

Short description

External Ids for this condition

Definition

Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Requirements

Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

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: .id

clinicalStatus

Σ ?! C

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Condition.clinicalStatus

Short description

Definition

The clinical status of the condition.

Comments

The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Data type

ConditionClinicalStatusCodes (required)

Binding

The clinical status of the condition or diagnosis.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, con-3, con-4, con-5

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.status
w5: FiveWs.status
sct-concept: < 303105007 |Disease phases|
v2: PRB-14
rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value

verificationStatus

Σ ?! C

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Condition.verificationStatus

Short description

Definition

The verification status to support the clinical status of the condition.

Comments

verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status. The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Data type

ConditionVerificationStatus (required)

Binding

The verification status to support or decline the clinical status of the condition or diagnosis.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.status
w5: FiveWs.status
sct-concept: < 410514004 |Finding context value|
v2: PRB-13
rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value
sct-attr: 408729009

profile-output-operation-outcome (OperationOutcome)

OperationOutcome

Element id

OperationOutcome

Short description

n/a

Definition

Outcome of Operation

Comments

Can result from the failure of a REST call or be part of the response message returned from a request message.

Data type

OperationOutcome

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.exists() and ('#'+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(uri) = '#').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
rim: Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)
w5: infrastructure.exchange

0..0

There are no (further) constraints on this element

Element id

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

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..0

There are no (further) constraints on this element

Element id

OperationOutcome.meta

Short description

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.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

There are no (further) constraints on this element

Element id

OperationOutcome.implicitRules

Short description

A set of rules under which this content was created

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

OperationOutcome.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

IETF language tag

Binding extensions

maxValueSet	AllLanguages

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

There are no (further) constraints on this element

Element id

OperationOutcome.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

There are no (further) constraints on this element

Element id

OperationOutcome.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

There are no (further) constraints on this element

Element id

OperationOutcome.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

OperationOutcome.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

issue

1..1

Element id

OperationOutcome.issue

Short description

n/a

Definition

An error, warning, or information message that results from a system action.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR
rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]

0..1

There are no (further) constraints on this element

Element id

OperationOutcome.issue.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

OperationOutcome.issue.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
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..0

There are no (further) constraints on this element

Element id

OperationOutcome.issue.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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

severity

1..1

codeBinding

There are no (further) constraints on this element

Element id

OperationOutcome.issue.severity

Short description

fatal | error | warning | information

Definition

Indicates whether the issue indicates a variation from successful processing.

Requirements

Indicates how relevant the issue is to the overall success of the action.

Comments

This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.

Data type

Binding

How the issue affects the success of the action.

IssueSeverity (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR-4
rim: ./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode="OBS" and moodCode="EVN" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type="CD"]

code

1..1

codeBinding

There are no (further) constraints on this element

Element id

OperationOutcome.issue.code

Short description

Error or warning code

Definition

Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.

Requirements

Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.

The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

A code that describes the type of issue.

IssueType (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR-3
rim: ./code

details

0..1

There are no (further) constraints on this element

Element id

OperationOutcome.issue.details

Short description

Additional details about the error

Definition

Additional details about the error. This may be a text description of the error or a system code that identifies the error.

Comments

A human readable description of the error issue SHOULD be placed in details.text.

Data type

http://hl7.org/fhir/ValueSet/operation-outcome (example)

Binding

A code that provides details as the exact issue.

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

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

diagnostics

0..0

There are no (further) constraints on this element

Element id

OperationOutcome.issue.diagnostics

Short description

Additional diagnostic information about the issue

Definition

Additional diagnostic information about the issue.

Comments

This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR-8
rim: ./text[parent::AcknowledgmentDetail]

location

0..0

There are no (further) constraints on this element

Element id

OperationOutcome.issue.location

Short description

Deprecated: Path of element(s) related to issue

Definition

This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse.

For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.

Requirements

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

Comments

The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.

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 unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR-2
rim: ./location[parent::AcknowledgmentDetail]

expression

0..0

There are no (further) constraints on this element

Element id

OperationOutcome.issue.expression

Short description

FHIRPath of element(s) related to issue

Definition

A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

Requirements

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

Comments

The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.

Data type