Skip to content

Commit 8675414

Browse files
committed
Updating and consolidating troubleshooting guides
1 parent a70db9e commit 8675414

File tree

6 files changed

+58
-85
lines changed

6 files changed

+58
-85
lines changed

.openpublishing.redirection.healthcare-apis.json

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -610,11 +610,15 @@
610610
"redirect_document_id": false
611611
},
612612
{ "source_path_from_root": "/articles/healthcare-apis/iot/iot-troubleshoot-error-messages-and-conditions.md",
613-
"redirect_url": "/azure/healthcare-apis/iot/troubleshoot-error-messages-and-conditions",
613+
"redirect_url": "/azure/healthcare-apis/iot/troubleshoot-errors",
614+
"redirect_document_id": false
615+
},
616+
{ "source_path_from_root": "/articles/healthcare-apis/iot/troubleshoot-error-messages-and-conditions.md",
617+
"redirect_url": "/azure/healthcare-apis/iot/troubleshoot-errors",
614618
"redirect_document_id": false
615619
},
616620
{ "source_path_from_root": "/articles/healthcare-apis/iot/iot-troubleshoot-mappings.md",
617-
"redirect_url": "/azure/healthcare-apis/iot/troubleshoot-mappings",
621+
"redirect_url": "/azure/healthcare-apis/iot/troubleshoot-errors",
618622
"redirect_document_id": false
619623
},
620624
{ "source_path_from_root": "/articles/healthcare-apis/iot/iot-connector-faqs.md",
@@ -637,6 +641,10 @@
637641
"redirect_url": "/azure/healthcare-apis/iot/deploy-new-arm",
638642
"redirect_document_id": false
639643
},
644+
{ "source_path_from_root": "/articles/healthcare-apis/iot/troubleshoot-mappings.md",
645+
"redirect_url": "/azure/healthcare-apis/iot/troubleshoot-errors",
646+
"redirect_document_id": false
647+
},
640648
{ "source_path_from_root": "/articles/healthcare-apis/events/events-display-metrics.md",
641649
"redirect_url": "/azure/healthcare-apis/events/events-use-metrics",
642650
"redirect_document_id": false

articles/healthcare-apis/iot/how-to-configure-device-mappings.md

Lines changed: 25 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: how-to
8-
ms.date: 12/27/2022
8+
ms.date: 1/12/2023
99
ms.author: jasteppe
1010
---
1111

@@ -61,6 +61,29 @@ The content payload itself is an Azure Event Hubs message, which is composed of
6161
}
6262
}
6363
```
64+
65+
## Device mappings validations
66+
67+
The validation process validates the device mappings before allowing them to be saved for use. These elements are required in the device mapping templates.
68+
69+
**Device mappings**
70+
71+
|Element|Required|
72+
|:-------|:------|
73+
|TypeName|True|
74+
|TypeMatchExpression|True|
75+
|DeviceIdExpression|True|
76+
|TimestampExpression|True|
77+
|Values[].ValueName|True|
78+
|Values[].ValueExpression|True|
79+
80+
> [!NOTE]
81+
> `Values[].ValueName and Values[].ValueExpression` elements are only required if you have a value entry in the array. It's valid to have no values mapped. This is used when the telemetry being sent is an event.
82+
>
83+
> For example:
84+
>
85+
> Some IoMT scenarios may require creating an Observation Resource in the FHIR service that does not contain a value.
86+
6487
## CollectionContentTemplate
6588

6689
The CollectionContentTemplate is the **root** template type used by the MedTech service device mappings template and represents a list of all templates that will be used during the normalization process.
@@ -179,7 +202,7 @@ You can define one or more templates within the MedTech service device mapping.
179202
|[IotJsonPathContentTemplate](how-to-use-iot-jsonpath-content-mappings.md)|A template that supports messages sent from Azure Iot Hub or the Legacy Export Data feature of Azure Iot Central.
180203

181204
> [!TIP]
182-
> See the MedTech service article [Troubleshoot MedTech service device and FHIR destination mappings](troubleshoot-mappings.md) for assistance fixing common errors and issues related to MedTech service mappings.
205+
> See the MedTech service article [Troubleshoot MedTech errors](troubleshoot-errors.md) for assistance resolving common MedTech service errors.
183206
184207
## Next steps
185208

articles/healthcare-apis/iot/how-to-configure-fhir-mappings.md

Lines changed: 15 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: how-to
8-
ms.date: 12/27/2022
8+
ms.date: 1/12/2023
99
ms.author: jasteppe
1010
---
1111

@@ -25,6 +25,19 @@ configuration controls.
2525
> [!NOTE]
2626
> Mappings are stored in an underlying blob storage and loaded from blob per compute execution. Once updated they should take effect immediately.
2727
28+
## FHIR destination mappings validations
29+
30+
The validation process validates the FHIR destination mappings before allowing them to be saved for use. These elements are required in the FHIR destination mappings templates.
31+
32+
**FHIR destination mappings**
33+
34+
|Element|Required|
35+
|:------|:-------|
36+
|TypeName|True|
37+
38+
> [!NOTE]
39+
> This is the only required FHIR destination mapping element validated at this time.
40+
2841
### CodeValueFhirTemplate
2942

3043
The CodeValueFhirTemplate 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), and [Quantity](https://www.hl7.org/fhir/datatypes.html#Quantity). Along with these configurable values, the identifier for the Observation resource and linking to the proper Device and Patient resources are handled automatically.
@@ -262,7 +275,7 @@ Represents the [CodeableConcept](http://hl7.org/fhir/datatypes.html#CodeableConc
262275
```
263276

264277
> [!TIP]
265-
> See the MedTech service article [Troubleshoot the MedTech service device and FHIR destination mappings](troubleshoot-mappings.md) for assistance fixing common errors and issues related to MedTech service mappings.
278+
> See the MedTech service article [Troubleshoot MedTech errors](troubleshoot-errors.md) for assistance resolving common MedTech service errors.
266279
267280
## Next steps
268281

articles/healthcare-apis/iot/toc.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,11 @@ items:
7171
href: how-to-configure-metrics.md
7272
- name: Enable diagnostic settings
7373
href: how-to-enable-diagnostic-settings.md
74-
- name: Troubleshoot and problem solve
74+
- name: Troubleshoot
7575
expanded: false
7676
items:
77-
- name: Errors and conditions
78-
href: troubleshoot-error-messages-and-conditions.md
79-
- name: Device and FHIR destination mappings
80-
href: troubleshoot-mappings.md
77+
- name: Errors
78+
href: troubleshoot-errors.md
8179
- name: Concepts
8280
expanded: false
8381
items:

articles/healthcare-apis/iot/troubleshoot-error-messages-and-conditions.md renamed to articles/healthcare-apis/iot/troubleshoot-errors.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: Troubleshoot MedTech service error messages and conditions - Azure Health Data Services
3-
description: This article helps users troubleshoot MedTech service errors messages and conditions.
2+
title: Troubleshoot MedTech service errors - Azure Health Data Services
3+
description: This article assist troubleshooting and resolving MedTech service errors.
44
services: healthcare-apis
55
author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: iomt
88
ms.topic: troubleshooting
9-
ms.date: 12/15/2022
9+
ms.date: 1/12/2023
1010
ms.author: jasteppe
1111
---
1212

13-
# Troubleshoot MedTech service error messages and conditions
13+
# Troubleshoot MedTech service errors
1414

15-
This article provides steps for troubleshooting and fixing MedTech service error messages and conditions.
15+
This article provides assistance troubleshooting and resolving MedTech service errors.
1616

1717
> [!TIP]
1818
> Having access to metrics and logs are essential tools for assisting you in troubleshooting and assessing the overall performance of your MedTech service. Check out these MedTech service articles to learn more about how to enable, configure, and use these monitoring features:

articles/healthcare-apis/iot/troubleshoot-mappings.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

0 commit comments

Comments
 (0)