HL7 FHIR JP Core ImplementationGuide
1.1.1 - release Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.1). See the Directory of published versions

Extension: JP_MedicationDosage_UsageDuration - Detailed Descriptions

Active as of 2022-10-24

Definitions for the jp-medicationdosage-usageduration extension.

1. Extension
Definition

隔日投与などで実投与日数と処方期間が異なる場合に用いられる。

Optional Extension Element - found in all resources.

2. Extension.extension
Control0..0*
3. Extension.url
Fixed Valuehttp://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_MedicationDosage_UsageDuration
4. Extension.value[x]
Definition

隔日投与などで実投与日数と処方期間が異なる場合に用いられる。

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

TypeChoice of: , date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
5. Extension.value[x].id
Definition

JP Coreでは使用されない。

Control0..?
6. Extension.value[x].value
Definition

隔日投与などで実投与日数と処方期間が異なる場合に用いられる。

Control0..?
7. Extension.value[x].unit
Definition

「日」で固定される

Control0..?
Fixed Value
8. Extension.value[x].system
Definition

単位コード UCUMを識別するURI。固定値。

Control0..?
Fixed Valuehttp://unitsofmeasure.org
9. Extension.value[x].code
Definition

単位コードUCUMにおける実投与日数の単位。dで固定される

Control0..?
Fixed Valued
1. Extension
Definition

隔日投与などで実投与日数と処方期間が異なる場合に用いられる。

Optional Extension Element - found in all resources.

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

An Extension

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.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. Extension.url
Definition

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

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
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.

Fixed Valuehttp://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_MedicationDosage_UsageDuration
4. Extension.value[x]
Definition

隔日投与などで実投与日数と処方期間が異なる場合に用いられる。

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

Control0..1
TypeChoice of: Duration, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Extension.value[x].id
Definition

JP Coreでは使用されない。

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
6. Extension.value[x].value
Definition

隔日投与などで実投与日数と処方期間が異なる場合に用いられる。

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control0..1
Typedecimal
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Extension.value[x].comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingThe codes SHALL be taken from QuantityComparator

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Extension.value[x].unit
Definition

「日」で固定される

A human-readable form of the unit.

Control0..1
Typestring
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Fixed Value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Extension.value[x].system
Definition

単位コード UCUMを識別するURI。固定値。

The identification of the system that provides the coded form of the unit.

Control0..1 This element is affected by the following invariants: qty-3
Typeuri
Requirements

Need to know the system that defines the coded form of the unit.

Fixed Valuehttp://unitsofmeasure.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Extension.value[x].code
Definition

単位コードUCUMにおける実投与日数の単位。dで固定される

A computer processable form of the unit in some unit representation system.

Control0..1
Typecode
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Fixed Valued
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1. Extension
Definition

隔日投与などで実投与日数と処方期間が異なる場合に用いられる。

Control0..* This element is affected by the following invariants: ele-1
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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Extension.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.url
Definition

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

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
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.

Fixed Valuehttp://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_MedicationDosage_UsageDuration
5. Extension.value[x]
Definition

隔日投与などで実投与日数と処方期間が異なる場合に用いられる。

Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Extension.value[x].id
Definition

JP Coreでは使用されない。

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
7. Extension.value[x].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.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. Extension.value[x].value
Definition

隔日投与などで実投与日数と処方期間が異なる場合に用いられる。

Control0..1
Typedecimal
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Extension.value[x].comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingThe codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented
Typecode
Is Modifiertrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Extension.value[x].unit
Definition

「日」で固定される

Control0..1
Typestring
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Fixed Value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Extension.value[x].system
Definition

単位コード UCUMを識別するURI。固定値。

Control0..1 This element is affected by the following invariants: qty-3
Typeuri
Requirements

Need to know the system that defines the coded form of the unit.

Fixed Valuehttp://unitsofmeasure.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Extension.value[x].code
Definition

単位コードUCUMにおける実投与日数の単位。dで固定される

Control0..1
Typecode
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Fixed Valued
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))