Skip to content

Commit e9bf616

Browse files
msjasteppemsjasteppe
committed
Merge branch 'quick-fhir-edits' of https://github.com/msjasteppe/azure-docs-pr 
2 parents cc32536 + 9232f0d commit e9bf616

File tree

3 files changed

+55
-64
lines changed

3 files changed

+55
-64
lines changed

‎articles/healthcare-apis/iot/media/overview-of-fhir-destination-mapping/fhir-destination-mapping-templates-diagram.png

4.29 KB
Loading

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: msjasteppe
55
ms.service: healthcare-apis
66
ms.subservice: fhir
77
ms.topic: overview
8-
ms.date: 04/14/2023
8+
ms.date: 04/24/2023
99
ms.author: jasteppe
1010
---
1111

@@ -52,7 +52,7 @@ The normalization process validates the device mapping before allowing it to be
5252
|values[].required |True |True |
5353

5454
> [!NOTE]
55-
> `values[].valueName, values[].valueExpression`, `values[].required` and elements are only required if you have a value entry in the array. It's valid to have no values mapped. These elements are used when the telemetry being sent is an event.
55+
> The `values[].valueName, values[].valueExpression`, and `values[].required` elements are only required if you have a value entry in the array. It's valid to have no values mapped. These elements are used when the telemetry being sent is an event.
5656
>
5757
> For example, some scenarios may require creating a FHIR Observation in the FHIR service that does not contain a value.
5858

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

Lines changed: 53 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: msjasteppe
55
ms.service: healthcare-apis
66
ms.subservice: fhir
77
ms.topic: overview
8-
ms.date: 04/17/2023
8+
ms.date: 04/24/2023
99
ms.author: jasteppe
1010
---
1111

@@ -23,11 +23,11 @@ The MedTech service requires two types of [JSON](https://www.json.org/) mappings
2323
2424
## FHIR destination mapping basics
2525

26-
The FHIR destination mapping controls how the normalized data extracted from a device message is mapped into a FHIR observation.
26+
The FHIR destination mapping controls how the normalized data extracted from a device message is mapped into a FHIR Observation.
2727

28-
- Should an observation be created for a point in time or over a period of an hour?
29-
- What codes should be added to the observation?
30-
- Should the value be represented as [SampledData](https://www.hl7.org/fhir/datatypes.html#SampledData) or a [Quantity](https://www.hl7.org/fhir/datatypes.html#Quantity)?
28+
* Should an observation be created for a point in time or over a period of an hour?
29+
* What codes should be added to the observation?
30+
* Should the value be represented as [SampledData](https://www.hl7.org/fhir/datatypes.html#SampledData) or a [Quantity](https://www.hl7.org/fhir/datatypes.html#Quantity)?
3131

3232
These data types are all options the FHIR destination mapping configuration controls.
3333

@@ -43,84 +43,75 @@ 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 validation process validates the FHIR destination mapping before allowing them to be saved for use. These elements are required in the FHIR destination mapping.
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.
6249

6350
### CodeValueFhir
6451

65-
CodeValueFhir is currently the only template supported in FHIR destination mapping at this time. 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#primitive). Along with these configurable values, the identifier for the Observation resource and linking to the proper Device and Patient resources are handled automatically.
66-
67-
> [!NOTE]
68-
>
69-
70-
|Property|Description|
71-
|:-------|-----------|
72-
|**typeName**| The type of measurement this template should bind to. There should be at least one Device mapping template that outputs this type.
73-
|**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.
74-
|**category**|Any number of [CodeableConcepts](http://hl7.org/fhir/datatypes-definitions.html#codeableconcept) to classify the type of observation created.
75-
|**codes**|One or more [Codings](http://hl7.org/fhir/datatypes-definitions.html#coding) to apply to the observation created.
76-
|**codes[].code**|The code for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).
77-
|**codes[].system**|The system for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).
78-
|**codes[].display**|The display for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).
79-
|**value**|The value to extract and represent in the observation. For more information, see [Value type codes](#value-type-codes).
80-
|**components**|*Optional:* One or more components to create on the observation.
81-
|**components[].codes**|One or more [Codings](http://hl7.org/fhir/datatypes-definitions.html#coding) to apply to the component.
82-
|**components[].value**|The value to extract and represent in the component. For more information, see [Value type codes](#value-type-codes).
52+
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.
53+
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|
8367

8468
:::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":::
8569

86-
### Value type codes
70+
### Value types
71+
72+
All CodeValueFhir templates' `value` element contains these elements:
73+
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|
8778

88-
The supported value type codes for the MedTech service FHIR destination mapping:
79+
These value types are supported in the MedTech service FHIR destination mapping:
8980

90-
### SampledData
81+
#### SampledData
9182

92-
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 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.
83+
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:
9384

94-
| Property | Description
95-
| --- | ---
96-
|**DefaultPeriod**|The default period in milliseconds to use.
97-
|**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|
9889

99-
### Quantity
90+
#### Quantity
10091

101-
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.
92+
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:
10293

103-
| Property | Description
104-
| --- | ---
105-
|**Unit**| Unit representation.
106-
|**Code**| Coded form of the unit.
107-
|**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|
10899

109-
### CodeableConcept
100+
#### CodeableConcept
110101

111-
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.
102+
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:
112103

113-
| Property | Description
114-
| --- | ---
115-
|**Text**|Plain text representation.
116-
|**Codes**|One or more [Codings](http://hl7.org/fhir/datatypes-definitions.html#coding) to apply to the observation created.
117-
|**Codes[].Code**|The code for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).
118-
|**Codes[].System**|The system for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).
119-
|**Codes[].Display**|The display for the [Coding](http://hl7.org/fhir/datatypes-definitions.html#coding).
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|
120111

121-
### String
112+
#### String
122113

123-
Represents the [string](https://www.hl7.org/fhir/datatypes.html#string) FHIR data type. This type creates a single, point in time, Observation. If new value arrives that contains the same device identifier, measurement type, and timestamp, the previous Observation is updated to the new value.
114+
Represents the [string](https://www.hl7.org/fhir/datatypes.html#string) FHIR data type. This type creates a single, point in time, Observation. If new a value arrives that contains the same device identifier, measurement type, and timestamp, the previous Observation is updated to the new value. No other elements are defined.
124115

125116
### Example
126117

0 commit comments

Comments
 (0)