Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Extension: ExtensionPlanDefinition_Goal_Target_Detail - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-PlanDefinition.goa.tar.detail extension.

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

R5: PlanDefinition.goal.target.detail[x] additional types (string, boolean, integer, Ratio)


Optional Extension Element - found in all resources.

ShortR5: detail additional typesOptional Extensions Element
Comments

Element PlanDefinition.goal.target.detail[x] is mapped to FHIR R4 element PlanDefinition.goal.target.detail[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.goal.target.detail[x] do not cover the following types: boolean, integer, Ratio, string. The target context PlanDefinition.goal.target.detail[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.goal.target. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

Control0..1*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.goal.target.detail
4. Extension.value[x]
Definition

The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortThe target value to be achievedValue of extension
Comments

A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

Control0..1
TypeChoice of: string, boolean, integer, Ratio, date, Meta, Address, Attachment, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

R5: PlanDefinition.goal.target.detail[x] additional types (string, boolean, integer, Ratio)

ShortR5: detail additional types
Comments

Element PlanDefinition.goal.target.detail[x] is mapped to FHIR R4 element PlanDefinition.goal.target.detail[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.goal.target.detail[x] do not cover the following types: boolean, integer, Ratio, string. The target context PlanDefinition.goal.target.detail[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.goal.target. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

Control0..1
Is Modifierfalse
2. Extension.url
Control1..1
Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.goal.target.detail
4. Extension.value[x]
Definition

The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

ShortThe target value to be achieved
Comments

A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

Control0..1
TypeChoice of: string, boolean, integer, Ratio, date, Meta, Address, Attachment, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

R5: PlanDefinition.goal.target.detail[x] additional types (string, boolean, integer, Ratio)

ShortR5: detail additional types
Comments

Element PlanDefinition.goal.target.detail[x] is mapped to FHIR R4 element PlanDefinition.goal.target.detail[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.goal.target.detail[x] do not cover the following types: boolean, integer, Ratio, string. The target context PlanDefinition.goal.target.detail[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.goal.target. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

Control0..1
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Extension.extension
Definition

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

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
    • 6. Extension.url
    Definition

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

    Shortidentifies the meaning of the extension
    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.goal.target.detail
    8. Extension.value[x]
    Definition

    The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

    ShortThe target value to be achieved
    Comments

    A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

    Control0..1
    TypeChoice of: string, boolean, integer, Ratio
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))