TBR
A Custom_TBR is a named TBR that can be applied to a basal insulin administration.
The "master" definition of the custom TBRs is a CarePlan. When a custom TBR (or TBR, for short) is applied, the name of the TBR in effect is not carried in the actual MedicationAdministration instance/resource, only the TBR adjustment and duration. Duration is only informed in BASAL tags when TBR period starts (remark element).
This extension is used in MedicationAdministration and Custom-TBR-CarePlan resources.
The scope of this extension is ACSPIX IP file.
For CarePlan TBR mapping, we would have this ACSPIX input (e.g.):
<PUMP_SETTINGS LowCartridgeAlarmQuantity="25.00" InfusionSetCannulaFillAmount="0.70" InfusionSetTubingFillAmount="14.00" BolusIncrement="0.50" DeliverySpeed="0">
<BASAL_RATE_SETTINGS MaximumHourlyBasalRate="25.00" ActiveProf="1" />
<CUSTOM_TBRS>
<CUSTOM_TBR Name="Hipo" Adjustment="10" Duration="30" />
<CUSTOM_TBR Name="Regla" Adjustment="90" Duration="600" />
<CUSTOM_TBR Name="Correr" Adjustment="0" Duration="75" />
<CUSTOM_TBR Name="Dia Gimnasio" Adjustment="90" Duration="630" />
</CUSTOM_TBRS>
</PUMP_SETTINGS>
For each CUSTOM_TBR tag inside of CUSTOM_TBRS tag, we would have a complete tbr extension. FHIR output is showed below (only one TBR extension included for each repetition of activity element in CarePlan resource):
"activity": [{
"extension": [{
"url": "http://roche.com/fhir/rdc/StructureDefinition/tbr",
"extension": [{
"url": "name",
"valueString": "Hipo"
}, {
"url": "adjustment",
"valueQuantity": {
"value": "10",
"unit": "%",
"system": "https://unitsofmeasure.org",
"code": "%"
}
}, {
"url": "duration",
"valueQuantity": {
"value": "30",
"unit": "min",
"system": "https://unitsofmeasure.org",
"code": "min"
}
}
]
}
]
}, {
"extension": [{
"url": "http://roche.com/fhir/rdc/StructureDefinition/tbr",
"extension": [{
"url": "name",
"valueString": "Regla"
}, {
"url": "adjustment",
"valueQuantity": {
"value": "90",
"unit": "%",
"system": "https://unitsofmeasure.org",
"code": "%"
}
}, {
"url": "duration",
"valueQuantity": {
"value": "600",
"unit": "min",
"system": "https://unitsofmeasure.org",
"code": "min"
}
}
]
}
]
}, {
"extension": [{
"url": "http://roche.com/fhir/rdc/StructureDefinition/tbr",
"extension": [{
"url": "name",
"valueString": "Correr"
}, {
"url": "adjustment",
"valueQuantity": {
"value": "0",
"unit": "%",
"system": "https://unitsofmeasure.org",
"code": "%"
}
}, {
"url": "duration",
"valueQuantity": {
"value": "75",
"unit": "min",
"system": "https://unitsofmeasure.org",
"code": "min"
}
}
]
}
]
}, {
"extension": [{
"url": "http://roche.com/fhir/rdc/StructureDefinition/tbr",
"extension": [{
"url": "name",
"valueString": "Dia Gimnasio"
}, {
"url": "adjustment",
"valueQuantity": {
"value": "90",
"unit": "%",
"system": "https://unitsofmeasure.org",
"code": "%"
}
}, {
"url": "duration",
"valueQuantity": {
"value": "630",
"unit": "min",
"system": "https://unitsofmeasure.org",
"code": "min"
}
}
]
}
]
}
]
For Medication Administration mapping, we would have this ACSPIX input (e.g):
<BASAL Dt="2017-11-20" Tm="02:19" cbrf="0.06" profile="1" TBRdec=" 10%" remark="dur 00:30 h" />
FHIR output example for TBRdec=" 10%" remark="dur 00:30 h" (extension is located inside of MedicationAdministration.dosage element):
"extension": [{
"url": "http://roche.com/fhir/rdc/StructureDefinition/tbr",
"extension": [{
"url": "adjustment",
"valueQuantity": {
"value": "10",
"unit": "%",
"system": "https://unitsofmeasure.org",
"code": "%"
}
}, {
"url": "duration",
"valueQuantity": {
"value": "30",
"unit": "min",
"system": "https://unitsofmeasure.org",
"code": "min"
}
}
]
}
]
Overview
The below overview shows the elements of the resource, data type and the cardinality of each. Further details like "Binding"/"Fixed values"/"contraints" etc can be found on clicking on each element.
Canonical URL - http://roche.com/fhir/rdc/StructureDefinition/tbr
| tbr (Extension) | C | Extension | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| name | C | 0..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| url | 1..1 | uriFixed Value | |
| valueString | 0..1 | string | |
| adjustment | C | 0..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| url | 1..1 | uriFixed Value | |
| valueQuantity | 0..1 | QuantityBinding | |
| duration | C | 0..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| url | 1..1 | uriFixed Value | |
| valueQuantity | 0..1 | QuantityBinding | |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..0 |
Details
| Extension | |
| Short | Optional Extensions Element |
| Definition | Optional Extension Element - found in all resources. |
| Cardinality | 0..* |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.id | |
| Short | xml:id (or equivalent in JSON) |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Comments | Note that FHIR strings may not exceed 1MB in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.extension | |
| Short | Additional Content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| 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 |
|
| Mappings |
|
| Extension.extension:name | |
| Short | Additional Content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Cardinality | 0..1 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.extension:name.id | |
| Short | xml:id (or equivalent in JSON) |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Comments | Note that FHIR strings may not exceed 1MB in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.extension:name.extension | |
| Short | Additional Content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| 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 |
|
| Mappings |
|
| Extension.extension:name.url | |
| Short | identifies the meaning of the extension |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Cardinality | 1..1 |
| Type | uri |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Fixed Value | name |
| Mappings |
|
| Extension.extension:name.value[x]:valueString | |
| Short | Value of extension |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.extension:adjustment | |
| Short | Additional Content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Cardinality | 0..1 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.extension:adjustment.id | |
| Short | xml:id (or equivalent in JSON) |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Comments | Note that FHIR strings may not exceed 1MB in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.extension:adjustment.extension | |
| Short | Additional Content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| 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 |
|
| Mappings |
|
| Extension.extension:adjustment.url | |
| Short | identifies the meaning of the extension |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Cardinality | 1..1 |
| Type | uri |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Fixed Value | adjustment |
| Mappings |
|
| Extension.extension:adjustment.value[x]:valueQuantity | |
| Short | Value of extension |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Cardinality | 0..1 |
| Type | Quantity |
| Binding | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.extension:duration | |
| Short | Additional Content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Cardinality | 0..1 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.extension:duration.id | |
| Short | xml:id (or equivalent in JSON) |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Comments | Note that FHIR strings may not exceed 1MB in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.extension:duration.extension | |
| Short | Additional Content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| 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 |
|
| Mappings |
|
| Extension.extension:duration.url | |
| Short | identifies the meaning of the extension |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Cardinality | 1..1 |
| Type | uri |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Fixed Value | duration |
| Mappings |
|
| Extension.extension:duration.value[x]:valueQuantity | |
| Short | Value of extension |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Cardinality | 0..1 |
| Type | Quantity |
| Binding | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.url | |
| Short | identifies the meaning of the extension |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Cardinality | 1..1 |
| Type | uri |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Fixed Value | http://roche.com/fhir/rdc/StructureDefinition/tbr |
| Mappings |
|
| Extension.value[x] | |
| Short | Value of extension |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Cardinality | 0..0 |
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | code | CodeableConcept | Coding | ContactPoint | Count | date | dateTime | decimal | Distance | Duration | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | Period | positiveInt | Quantity | Range | Ratio | Reference | SampledData | Signature | string | time | Timing | unsignedInt | uri |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
Table
| Extension | 0..* | |
| Extension.id | string | 0..1 |
| Extension.extension | Extension | 0..* |
| Extension.extension:name | Extension | 0..1 |
| Extension.extension:name.id | string | 0..1 |
| Extension.extension:name.extension | Extension | 0..* |
| Extension.extension:name.url | uri | 1..1 |
| Extension.extension:name.value[x]:valueString | string | 0..1 |
| Extension.extension:adjustment | Extension | 0..1 |
| Extension.extension:adjustment.id | string | 0..1 |
| Extension.extension:adjustment.extension | Extension | 0..* |
| Extension.extension:adjustment.url | uri | 1..1 |
| Extension.extension:adjustment.value[x]:valueQuantity | Quantity | 0..1 |
| Extension.extension:duration | Extension | 0..1 |
| Extension.extension:duration.id | string | 0..1 |
| Extension.extension:duration.extension | Extension | 0..* |
| Extension.extension:duration.url | uri | 1..1 |
| Extension.extension:duration.value[x]:valueQuantity | Quantity | 0..1 |
| Extension.url | uri | 1..1 |
| Extension.value[x] | Address | Age | Annotation | Attachment | base64Binary | boolean | code | CodeableConcept | Coding | ContactPoint | Count | date | dateTime | decimal | Distance | Duration | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | Period | positiveInt | Quantity | Range | Ratio | Reference | SampledData | Signature | string | time | Timing | unsignedInt | uri | 0..0 |