Skip to content

Commit 9232f0d

Browse files
msjasteppemsjasteppe
committed
More updates based on feedback
1 parent 1f371a6 commit 9232f0d

File tree

1 file changed

+33
-46
lines changed

1 file changed

+33
-46
lines changed

‎articles/healthcare-apis/iot/overview-of-fhir-destination-mapping.md

Lines changed: 33 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,6 @@ This diagram provides an illustration of what happens during the transformation
4343
> [!NOTE]
4444
> The FHIR Observation in this diagram is not the complete resource. See [Example](#example) in this overview for the entire FHIR Observation.
4545
46-
## FHIR destination mapping validations
47-
48-
The transformation process validates the FHIR destination mapping before allowing it to be saved for use. These elements are required in the FHIR destination mapping templates.
49-
50-
**FHIR destination mapping**
51-
52-
|Element|Required|
53-
|:------|:-------|
54-
|typeName|True|
55-
56-
> [!NOTE]
57-
> The `typeName` element is used to link a FHIR destination mapping template to one or more device mapping templates. Device mapping templates with the same `typeName` element generate normalized data that will be evaluated with a FHIR destination mapping template that has the same `typeName`.
58-
5946
## CollectionFhir
6047

6148
CollectionFhir is the root template type used by the MedTech service FHIR destination mapping. CollectionFhir is a list of all templates that are used during the transformation stage. You can define one or more templates within CollectionFhir, with each normalized message evaluated against all templates.
@@ -64,63 +51,63 @@ CollectionFhir is the root template type used by the MedTech service FHIR destin
6451

6552
CodeValueFhir is currently the only template supported in FHIR destination mapping. It allows you to define codes, the effective period, and the value of the observation. Multiple value types are supported: [SampledData](https://www.hl7.org/fhir/datatypes.html#SampledData), [CodeableConcept](https://www.hl7.org/fhir/datatypes.html#CodeableConcept), [Quantity](https://www.hl7.org/fhir/datatypes.html#Quantity), and [string](https://www.hl7.org/fhir/datatypes.html#string). Along with these configurable values, the identifier for the Observation resource and linking to the proper Device and Patient resources are handled automatically.
6653

67-
|Element|Description|
68-
|:------|-----------|
69-
|**typeName**| The type of measurement this template should bind to. There should be at least one device mapping template that has this same `typeName`.
70-
|**periodInterval**|The period of time the observation created should represent. Supported values are 0 (an instance), 60 (an hour), 1440 (a day). Note: `periodInterval` is required when the Observation type is "SampledData" and is ignored for any other Observation types.
71-
|**category**|Any number of [CodeableConcepts](http://hl7.org/fhir/datatypes-definitions.html#codeableconcept) to classify the type of observation created.
72-
|**codes**|One or more [Codings](http://hl7.org/fhir/datatypes-definitions.html#coding) to apply to the observation created.
73-
|**codes[].code**|The code for a [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding) in the `codes` property.
74-
|**codes[].system**|The system for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).
75-
|**codes[].display**|The display for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).
76-
|**value**|The value to extract and represent in the observation. For more information, see [Value types](#value-types).
77-
|**components**|*Optional:* One or more components to create on the observation.
78-
|**components[].codes**|One or more [Codings](http://hl7.org/fhir/datatypes-definitions.html#coding) to apply to the component.
79-
|**components[].value**|The value to extract and represent in the component. For more information, see [Value types](#value-types).
54+
|Element|Description|Required|
55+
|:------|:----------|:-------|
56+
|**typeName**| The type of measurement this template should bind to. There should be at least one device mapping template that has this same `typeName`.|TBD|
57+
|**periodInterval**|The period of time the observation created should represent. Supported values are 0 (an instance), 60 (an hour), 1440 (a day).|TBD Note: `periodInterval` is required when the Observation type is "SampledData" and is ignored for any other Observation types.|
58+
|**category**|Any number of [CodeableConcepts](http://hl7.org/fhir/datatypes-definitions.html#codeableconcept) to classify the type of observation created.|TBD|
59+
|**codes**|One or more [Codings](http://hl7.org/fhir/datatypes-definitions.html#coding) to apply to the observation created.|TBD|
60+
|**codes[].code**|The code for a [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding) in the `codes` property.|TBD|
61+
|**codes[].system**|The system for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).|TBD|
62+
|**codes[].display**|The display for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).|TBD|
63+
|**value**|The value to extract and represent in the observation. For more information, see [Value types](#value-types).|TBD|
64+
|**components**|*Optional:* One or more components to create on the observation.|TBD|
65+
|**components[].codes**|One or more [Codings](http://hl7.org/fhir/datatypes-definitions.html#coding) to apply to the component.|TBD|
66+
|**components[].value**|The value to extract and represent in the component. For more information, see [Value types](#value-types).|TBD|
8067

8168
:::image type="content" source="media/overview-of-fhir-destination-mapping/fhir-destination-mapping-templates-diagram.png" alt-text="Diagram showing MedTech service FHIR destination mapping template and code architecture." lightbox="media/overview-of-fhir-destination-mapping/fhir-destination-mapping-templates-diagram.png":::
8269

8370
### Value types
8471

8572
All CodeValueFhir templates' `value` element contains these elements:
8673

87-
|Element|Description|
88-
|:------|:----------|
89-
|**valueType**|Type of the value. This value would be "SampledData", "Quantity", "CodeableConcept", or "string" depending on the value type.|
90-
|**valueName**|Name of the value.|
74+
|Element|Description|Required|
75+
|:------|:----------|:-------|
76+
|**valueType**|Type of the value. This value would be "SampledData", "Quantity", "CodeableConcept", or "string" depending on the value type.|TBD|
77+
|**valueName**|Name of the value.|TBD|
9178

9279
These value types are supported in the MedTech service FHIR destination mapping:
9380

9481
#### SampledData
9582

9683
Represents the [SampledData](http://hl7.org/fhir/datatypes.html#SampledData) FHIR data type. Observation measurements are written to a value stream starting at a point in time and incrementing forward using the period defined. If no value is present, an `E` is written into the data stream. If the period is such that two or more values occupy the same position in the data stream, the latest value is used. The same logic is applied when an observation using the SampledData is updated. For a CodeValueFhir template with the SampleData value type, the template's `value` element contains the following elements:
9784

98-
|Element|Description|
99-
|:------|:----------|
100-
|**defaultPeriod**|The default period in milliseconds to use.
101-
|**unit**|The unit to set on the origin of the SampledData.
85+
|Element|Description|Required|
86+
|:------|:----------|:-------|
87+
|**defaultPeriod**|The default period in milliseconds to use.|TBD|
88+
|**unit**|The unit to set on the origin of the SampledData. |TBD|
10289

10390
#### Quantity
10491

10592
Represents the [Quantity](http://hl7.org/fhir/datatypes.html#Quantity) FHIR data type. This type creates a single, point in time, Observation. If a new value arrives that contains the same device identifier, measurement type, and timestamp, the previous Observation is updated to the new value. For a CodeValueFhir template with the Quantity value type, the template's `value` element contains the following elements:
10693

107-
|Element|Description|
108-
|:------|:----------|
109-
|**unit**| Unit representation.
110-
|**code**| Coded form of the unit.
111-
|**system**| System that defines the coded unit form.
94+
|Element|Description|Required|
95+
|:------|:----------|:-------|
96+
|**unit**|Unit representation.|TBD|
97+
|**code**|Coded form of the unit.|TBD|
98+
|**system**|System that defines the coded unit form.|TBD|
11299

113100
#### CodeableConcept
114101

115102
Represents the [CodeableConcept](http://hl7.org/fhir/datatypes.html#CodeableConcept) FHIR data type. The value in the normalized data model isn't used, and instead when this type of data is received, an Observation is created with a specific code representing that an observation was recorded at a specific point in time. For a CodeValueFhir template with the CodeableConcept value type, the template's `value` element contains the following elements:
116103

117-
|Element|Description|
118-
|:------|:----------|
119-
|**text**|Plain text representation.
120-
|**codes**|One or more [Codings](http://hl7.org/fhir/datatypes-definitions.html#coding) to apply to the observation created.
121-
|**codes[].code**|The code for a [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding) in the `codes` property.
122-
|**codes[].system**|The system for a [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding) in the `codes` property.
123-
|**codes[].display**|The display for a [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding) in the `codes` property.
104+
|Element|Description|Required|
105+
|:------|:----------|:-------|
106+
|**text**|Plain text representation.|TBD|
107+
|**codes**|One or more [Codings](http://hl7.org/fhir/datatypes-definitions.html#coding) to apply to the observation created.|TBD|
108+
|**codes[].code**|The code for a [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding) in the `codes` property.|TBD|
109+
|**codes[].system**|The system for a [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding) in the `codes` property.|TBD|
110+
|**codes[].display**|The display for a [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding) in the `codes` property.|TBD|
124111

125112
#### String
126113

0 commit comments

Comments
 (0)