You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Now that you're able to connect to your FHIR server and POST data, you’re ready to write a web application that will read FHIR data. In this final step of the tutorial, we’ll walk through writing and accessing the web application.
17
+
Now that you're able to connect to your FHIR® server and POST data, you’re ready to write a web application that will read FHIR data. In this final step of the tutorial, we walk through writing and accessing the web application.
18
18
19
19
## Create web application
20
-
In Azure, select **Create a resource** and select **Web App**. Make sure to name your web application whatever you specified in the redirect URI for your client application or go back and update the redirect URI with the new name.
20
+
In Azure, select **Create a resource** and select **Web App**. Make sure to name your web application whatever you specified in the redirect URI for your client application, or go back and update the redirect URI with the new name.
21
21
22
22
23
23
24
-
Once the web application is available, **Go to resource**. Select **App Service Editor (Preview)** under Development Tools on the right and then select **Go**. Selecting Go will open up the App Service Editor. Right select in the grey space under *Explore* and create a new file called **index.html**.
24
+
Once the web application is available, select **Go to resource**. Select **App Service Editor (Preview)** under Development Tools on the right and then select **Go**. Selecting **Go** opens up the App Service Editor. Right select in the grey space under *Explore* and create a new file called **index.html**.
25
25
26
-
Included is the code that you can input into **index.html**. You’ll need to update the following items:
27
-
***clientId** - Update with your client application ID. This ID will be the same ID you pulled when retrieving your token
26
+
The following is the code that you can input into **index.html**. You’ll need to update the following items.
27
+
***clientId** - Update with your client application ID. This ID is the same ID you pulled when retrieving your token
28
28
***authority** - Update with your Microsoft Entra tenant ID
29
29
***FHIRendpoint** - Update the FHIRendpoint to have your FHIR service name
30
30
***scopes** - Update to reflect the full URL for your audience
@@ -146,9 +146,9 @@ From here, you can go back to your web application resource and open the URL fou
146
146
147
147
## Next Steps
148
148
149
-
You’ve successfully deployed the Azure API for FHIR, registered a public client application, tested access, and created a small web application. Check out the Azure API for FHIR supported features as a next step.
149
+
You’ve successfully deployed the Azure API for FHIR, registered a public client application, tested access, and created a small web application. As a next step, check out the Azure API for FHIR supported features.
150
150
151
151
>[!div class="nextstepaction"]
152
152
>[Supported Features](fhir-features-supported.md)
153
153
154
-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
[!INCLUDE[Specific IP ranges for storage account](../includes/custom-header-auditlog.md)]
17
+
[!INCLUDE[Specific IP ranges for storage account](../includes/custom-header-auditlog.md)]
18
18
19
19
## Next steps
20
20
21
-
In this article, you learned how to add data to audit logs by using custom headers in the Azure API for FHIR. For information about Azure API for FHIR configuration settings, see
21
+
In this article, you learned how to add data to audit logs by using custom headers in the Azure API for FHIR®. For information about Azure API for FHIR configuration settings, see
22
22
23
23
>[!div class="nextstepaction"]
24
24
>[Configure Azure RBAC](configure-azure-rbac.md)
@@ -38,5 +38,4 @@ In this article, you learned how to add data to audit logs by using custom heade
In the [store profiles in Azure API for FHIR](store-profiles-in-fhir.md) article, you walked through the basics of FHIR profiles and storing them. This article guides you through how to use `$validate` for validating resources against profiles. Validating a resource against a profile means checking if the resource conforms to the profile, including the specifications listed in `Resource.meta.profile` or in an Implementation Guide (IG).
16
17
17
-
In the [store profiles in Azure API for FHIR](store-profiles-in-fhir.md) article, you walked through the basics of FHIR profiles and storing them. This article will guide you through how to use `$validate` for validating resources against profiles. Validating a resource against a profile means checking if the resource conforms to the profile, including the specifications listed in `Resource.meta.profile` or in an Implementation Guide.
18
-
19
-
`$validate` is an operation in Fast Healthcare Interoperability Resources (FHIR®) that allows you to ensure that a FHIR resource conforms to the base resource requirements or a specified profile. This operation ensures that the data in Azure API for FHIR has the expected attributes and values. For information on validate operation, visit [HL7 FHIR Specification](https://www.hl7.org/fhir/resource-operation-validate.html). Per specification, Mode can be specified with `$validate`, such as create and update:
18
+
`$validate` is an operation in Fast Healthcare Interoperability Resources (FHIR®) that allows you to ensure that a FHIR resource conforms to the base resource requirements or a specified profile. This operation ensures that the data in Azure API for FHIR has the expected attributes and values. For information on validate operation, visit [HL7 FHIR Specification](https://www.hl7.org/fhir/resource-operation-validate.html). Per the specification, Mode can be specified with `$validate`, such as create and update.
20
19
21
20
-`create`: Azure API for FHIR checks that the profile content is unique from the existing resources and that it's acceptable to be created as a new resource.
22
21
-`update`: Checks that the profile is an update against the nominated existing resource (that is no changes are made to the immutable fields).
23
22
24
-
There are different ways provided for you to validate resource:
23
+
There are different ways provided for you to validate resource.
25
24
26
25
- Validate an existing resource with validate operation.
27
26
- Validate a new resource with validate operation.
28
-
- Validate on resource CREATE/UPDATE using header.
27
+
- Validate on resource CREATE/UPDATE using a header.
29
28
30
-
Azure API for FHIR will always return an `OperationOutcome` as the validation results for $validate operation. Azure API for FHIR service does two step validation, once a resource is passed into $validate endpoint - the first step is a basic validation to ensure resource can be parsed. During resource parsing, individual errors need to be fixed before proceeding further to next step. Once resource is successfully parsed, full validation is conducted as second step.
29
+
Azure API for FHIR always returns an `OperationOutcome` as the validation results for `$validate` operation. Azure API for FHIR service does two step validation once a resource is passed into `$validate` endpoint. The first step is a basic validation to ensure resource can be parsed. During resource parsing, individual errors need to be fixed before proceeding to next step. Once a resource is successfully parsed, full validation is conducted as the second step.
31
30
32
31
> [!NOTE]
33
-
> Any valuesets that are to be used for validation must be uploaded to the FHIR server. This includes any Valuesets which are part of the FHIR specification, as well as any ValueSets defined in Implementation Guides. Only fully expanded Valuesets which contain a full list of all codes are supported. Any ValueSet definitions which reference external sources are not supported.
32
+
> Any `Valuesets` that are to be used for validation must be uploaded to the FHIR server. This includes any `Valuesets` which are part of the FHIR specification, as well as any `ValueSets` defined in Implementation Guides. Only fully expanded `Valuesets`, which contain a full list of all codes are supported. Any `ValueSet` definitions which reference external sources are not supported.
34
33
35
34
## Validating an existing resource
36
35
37
-
To validate an existing resource, use `$validate` in a `GET` request:
36
+
To validate an existing resource, use `$validate` in a `GET` request.
38
37
39
38
`GET http://<your Azure API for FHIR base URL>/{resource}/{resource ID}/$validate`
In this example, you're validating the existing Patient resource `a6e11662-def8-4dde-9ebc-4429e68d130e` against the base Patient resource. If it's valid, you'll get an `OperationOutcome` such as the following code example:
44
+
In this example, you're validating the existing Patient resource `a6e11662-def8-4dde-9ebc-4429e68d130e` against the base `Patient` resource. If it's valid, you get an `OperationOutcome` such as the following code example.
46
45
47
46
```json
48
47
{
@@ -56,7 +55,7 @@ In this example, you're validating the existing Patient resource `a6e11662-def8-
56
55
]
57
56
}
58
57
```
59
-
If the resource isn't valid, you'll get an error code and an error message with details on why the resource is invalid. An example `OperationOutcome` gets returned with error messages and could look like the following code example:
58
+
If the resource isn't valid, you get an error code and an error message with details on why the resource is invalid. An example `OperationOutcome` gets returned with error messages and could look like the following code example.
60
59
61
60
```json
62
61
{
@@ -100,30 +99,29 @@ If the resource isn't valid, you'll get an error code and an error message with
100
99
101
100
In this example, the resource didn't conform to the provided Patient profile, which required a patient identifier value and gender.
102
101
103
-
If you'd like to specify a profile as a parameter, you can specify the canonical URL for the profile to validate against, such as the following example for the HL7 base profile for `heartrate`:
102
+
If you'd like to specify a profile as a parameter, you can specify the canonical URL for the profile to validate against, such as the following example for the HL7 base profile for `heartrate`.
If you'd like to validate a new resource that you're uploading to Azure API for FHIR, you can do a `POST` request:
111
-
The server will always return an OperationOutcome as the result.
109
+
If you'd like to validate a new resource that you're uploading to Azure API for FHIR, you can do a `POST` request. The server always returns an OperationOutcome as the result.
112
110
113
111
`POST http://<your Azure API for FHIR base URL>/{Resource}/$validate`
This request will validate the resource. On validation resources are not created in FHIR service, you will need to send a POST request without $validate to create resource.
117
+
This request validates the resource. Resources aren't created in FHIR service on validation. You need to send a POST request without `$validate` to create a resource.
120
118
121
119
## Validate on resource CREATE/ UPDATE using header.
122
120
123
-
By default, Azure API for FHIR is configured to opt out of validation on resource `Create/Update`. This capability allows to validate on `Create/Update`, using the `x-ms-profile-validation` header. Set `x-ms-profile-validation' to true for validation.
121
+
By default, Azure API for FHIR is configured to opt out of validation on resource `Create/Update`. This capability allows validation on `Create/Update`, using the `x-ms-profile-validation` header. Set `x-ms-profile-validation` to true for validation.
124
122
125
123
> [!NOTE]
126
-
> In the open-source FHIR service, you can change the server configuration setting, under the CoreFeatures.
124
+
> In the open-source FHIR service, you can change the server configuration setting under CoreFeatures.
127
125
128
126
```json
129
127
{
@@ -142,4 +140,4 @@ In this article, you learned how to validate resources against profiles using `$
142
140
>[!div class="nextstepaction"]
143
141
>[Azure API for FHIR supported features](fhir-features-supported.md)
144
142
145
-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
0 commit comments