Skip to content

Commit 51fb5fd

Browse files
author
Jill Grant
authored
Merge pull request #267752 from EXPEkesheth/patch-fhir-release-51
FHIR Release 4.0.51
2 parents 07588b2 + 2aef31a commit 51fb5fd

File tree

4 files changed

+38
-12
lines changed

4 files changed

+38
-12
lines changed

articles/healthcare-apis/fhir/fhir-versioning-policy-and-history-management.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,17 @@ When configuring resource level configuration, you'll be able to select the FHIR
5858

5959
**Make sure** to select **Save** after you've completed your versioning policy configuration.
6060

61-
:::image type="content" source="media/versioning-policy/save-button.jpg" alt-text="Screenshot of Azure portal versioning policy configuration configuration showing save button." lightbox="media/versioning-policy/save-button.jpg":::
61+
:::image type="content" source="media/versioning-policy/save-button.jpg" alt-text="Screenshot of Azure portal versioning policy configuration showing save button." lightbox="media/versioning-policy/save-button.jpg":::
6262

6363
## History management
6464

6565
History in FHIR is important for end users to see how a resource has changed over time. It's also useful in coordination with audit logs to see the state of a resource before and after a user modified it. In general, it's recommended to keep history for a resource unless you know that the history isn't needed. Frequent updates of resources can result in a large amount of data storage, which can be undesired in FHIR services with a large amount of data.
6666

6767
Changing the versioning policy either at a system level or resource level won't remove the existing history for any resources in your FHIR service. If you're looking to reduce the history data size in your FHIR service, you must use the [$purge-history](purge-history.md) operation.
6868

69+
> [!NOTE]
70+
> The query parameter _summary=count and _count=0 can be added to _history endpoint to get count of all versioned resources. This count includes soft deleted resources.
71+
6972
## Next steps
7073

7174
In this article, you learned how to purge the history for resources in the FHIR service. For more information about how to disable history and some concepts about history management, see

articles/healthcare-apis/fhir/import-data.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ The `import` operation supports two modes: initial mode and incremental mode. Ea
2727

2828
- Optimized for loading data into the FHIR server periodically and doesn't block writes through the API.
2929

30-
- Allows you to load `lastUpdated` and `versionId` from resource metadata if present in the resource JSON.
30+
- Allows you to load `lastUpdated` and `versionId` from resource metadata if present in the resource JSON.
31+
32+
- Allows you to load resources in non-sequential order of versions.
3133

3234
* If import files don't have the `version` and `lastUpdated` field values specified, there's no guarantee of importing resources in FHIR service.
3335

articles/healthcare-apis/fhir/overview-of-search.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.author: kesheth
1010
---
1111
# Overview of FHIR search
1212

13-
The Fast Healthcare Interoperability Resources (FHIR®) specification defines an API for querying resources in a FHIR server database. This article will guide you through some key aspects of querying data in FHIR. For complete details about the FHIR search API, refer to the HL7 [FHIR Search](https://www.hl7.org/fhir/search.html) documentation.
13+
The Fast Healthcare Interoperability Resources (FHIR®) specification defines an API for querying resources in a FHIR server database. This article guides you through some key aspects of querying data in FHIR. For complete details about the FHIR search API, refer to the HL7 [FHIR Search](https://www.hl7.org/fhir/search.html) documentation.
1414

1515
Throughout this article, we'll demonstrate FHIR search syntax in example API calls with the `{{FHIR_URL}}` placeholder to represent the FHIR server URL. In the case of the FHIR service in Azure Health Data Services, this URL would be `https://<WORKSPACE-NAME>-<FHIR-SERVICE-NAME>.fhir.azurehealthcareapis.com`.
1616

@@ -28,7 +28,7 @@ In the following sections, we'll cover the various aspects of querying resources
2828

2929
## Search parameters
3030

31-
When you do a search in FHIR, you are searching the database for resources that match certain search criteria. The FHIR API specifies a rich set of search parameters for fine-tuning search criteria. Each resource in FHIR carries information as a set of elements, and search parameters work to query the information in these elements. In a FHIR search API call, if a positive match is found between the request's search parameters and the corresponding element values stored in a resource instance, then the FHIR server returns a bundle containing the resource instance(s) whose elements satisfied the search criteria.
31+
When you do a search in FHIR, you're searching the database for resources that match certain search criteria. The FHIR API specifies a rich set of search parameters for fine-tuning search criteria. Each resource in FHIR carries information as a set of elements, and search parameters work to query the information in these elements. In a FHIR search API call, if a positive match is found between the request's search parameters and the corresponding element values stored in a resource instance, then the FHIR server returns a bundle containing the resource instance(s) whose elements satisfied the search criteria.
3232

3333
For each search parameter, the FHIR specification defines the [data type(s)](https://www.hl7.org/fhir/search.html#ptypes) that can be used. Support in the FHIR service for the various data types is outlined below.
3434

@@ -66,7 +66,7 @@ There are [common search parameters](https://www.hl7.org/fhir/search.html#all) t
6666

6767
### Resource-specific parameters
6868

69-
The FHIR service in Azure Health Data Services supports almost all [resource-specific search parameters](https://www.hl7.org/fhir/searchparameter-registry.html) defined in the FHIR specification. Search parameters that are not supported are listed in the links below:
69+
The FHIR service in Azure Health Data Services supports almost all [resource-specific search parameters](https://www.hl7.org/fhir/searchparameter-registry.html) defined in the FHIR specification. Search parameters that aren't supported are listed in the links below:
7070

7171
* [STU3 Unsupported Search Parameters](https://github.com/microsoft/fhir-server/blob/main/src/Microsoft.Health.Fhir.Core/Data/Stu3/unsupported-search-parameters.json)
7272

@@ -81,7 +81,7 @@ GET {{FHIR_URL}}/metadata
8181
To view the supported search parameters in the capability statement, navigate to `CapabilityStatement.rest.resource.searchParam` for the resource-specific search parameters and `CapabilityStatement.rest.searchParam` for search parameters that apply to all resources.
8282

8383
> [!NOTE]
84-
> The FHIR service in Azure Health Data Services does not automatically index search parameters that are not defined in the base FHIR specification. However, the FHIR service does support [custom search parameters](how-to-do-custom-search.md).
84+
> The FHIR service in Azure Health Data Services does not automatically index search parameters that aren't defined in the base FHIR specification. However, the FHIR service does support [custom search parameters](how-to-do-custom-search.md).
8585
8686
### Composite search parameters
8787
Composite searches in FHIR allow you to search against element pairs as logically connected units. For example, if you were searching for observations where the height of the patient was over 60 inches, you would want to make sure that a single property of the observation contained the height code *and* a value greater than 60 inches (the value should only pertain to height). You wouldn't want to return a positive match on an observation with the height code *and* an arm to arm length over 60 inches, for example. Composite search parameters prevent this problem by searching against pre-specified pairs of elements whose values must both meet the search criteria for a positive match to occur.
@@ -119,15 +119,15 @@ For more information, see the HL7 [Composite Search Parameters](https://www.hl7.
119119
| `:above` (token) | No | No |
120120
| `:not-in` (token) | No | No |
121121

122-
For search parameters that have a specific order (numbers, dates, and quantities), you can use a [prefix](https://www.hl7.org/fhir/search.html#prefix) before the parameter value to refine the search criteria (e.g. `Patient?_lastUpdated=gt2022-08-01` where the prefix `gt` means "greater than"). The FHIR service in Azure Health Data Services supports all prefixes defined in the FHIR standard.
122+
For search parameters that have a specific order (numbers, dates, and quantities), you can use a [prefix](https://www.hl7.org/fhir/search.html#prefix) before the parameter value to refine the search criteria (for example, `Patient?_lastUpdated=gt2022-08-01` where the prefix `gt` means "greater than"). The FHIR service in Azure Health Data Services supports all prefixes defined in the FHIR standard.
123123

124124
### Search result parameters
125125
FHIR specifies a set of search result parameters to help manage the information returned from a search. For detailed information on how to use search result parameters in FHIR, refer to the [HL7](https://www.hl7.org/fhir/search.html#return) website. Below is a list of FHIR search result parameters and their support in the FHIR service.
126126

127127
| **Search result parameters** | **FHIR service in Azure Health Data Services** | **Azure API for FHIR** | **Comment**|
128128
| ------------------------- | -------------------- | ------------------------- | ------------|
129129
| `_elements` | Yes | Yes |
130-
| `_count` | Yes | Yes | `_count` is limited to 1000 resources. If it's set higher than 1000, only 1000 will be returned and a warning will be included in the bundle. |
130+
| `_count` | Yes | Yes | `_count` is limited to 1000 resources. If it's set higher than 1000, only 1000 are returned and a warning will be included in the bundle. |
131131
| `_include` | Yes | Yes | Items retrieved with `_include` are limited to 100. `_include` on PaaS and OSS on Azure Cosmos DB doesn't support `:iterate` [(#2137)](https://github.com/microsoft/fhir-server/issues/2137). |
132132
| `_revinclude` | Yes | Yes |Items retrieved with `_revinclude` are limited to 100. `_revinclude` on PaaS and OSS on Azure Cosmos DB doesn't support `:iterate` [(#2137)](https://github.com/microsoft/fhir-server/issues/2137). There's also an incorrect status code for a bad request [#1319](https://github.com/microsoft/fhir-server/issues/1319). |
133133
| `_summary` | Yes | Yes |
@@ -137,10 +137,11 @@ FHIR specifies a set of search result parameters to help manage the information
137137
| `_containedType` | No | No |
138138
| `_score` | No | No |
139139

140-
> [!NOTE]
141-
> By default, `_sort` arranges records in ascending order. You can also use the prefix `-` to sort in descending order. The FHIR service only allows you to sort on a single field at a time.
140+
Note:
141+
1. By default, `_sort` arranges records in ascending order. You can also use the prefix `-` to sort in descending order. The FHIR service only allows you to sort on a single field at a time.
142+
1. FHIR service supports wild card searches with revinclude. Adding "*.*" query parameter in revinclude query, it directs FHIR service to reference all the resources mapped to the source resource.
142143

143-
By default, the FHIR service in Azure Health Data Services is set to lenient handling. This means that the server will ignore any unknown or unsupported parameters. If you want to use strict handling, you can include the `Prefer` header and set `handling=strict`.
144+
By default, the FHIR service in Azure Health Data Services is set to lenient handling. This means that the server ignores any unknown or unsupported parameters. If you want to use strict handling, you can include the `Prefer` header and set `handling=strict`.
144145

145146
## Chained & reverse chained searching
146147

@@ -154,7 +155,7 @@ Similarly, you can do a reverse chained search with the `_has` parameter. This a
154155

155156
## Pagination
156157

157-
As mentioned above, the results from a FHIR search will be available in paginated form at a link provided in the `searchset` bundle. By default, the FHIR service will display 10 search results per page, but this can be increased (or decreased) by setting the `_count` parameter. If there are more matches than fit on one page, the bundle will include a `next` link. Repeatedly fetching from the `next` link will yield the subsequent pages of results. Note that the `_count` parameter value cannot exceed 1000.
158+
As mentioned above, the results from a FHIR search is available in paginated form at a link provided in the `searchset` bundle. By default, the FHIR service displays 10 search results per page, but this can be increased (or decreased) by setting the `_count` parameter. If there are more matches than fit on one page, the bundle includes a `next` link. Repeatedly fetching from the `next` link yields the subsequent pages of results. Note that the `_count` parameter value can't exceed 1000.
158159

159160
Currently, the FHIR service in Azure Health Data Services only supports the `next` link and doesn’t support `first`, `last`, or `previous` links in bundles returned from a search.
160161

articles/healthcare-apis/release-notes.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,26 @@ This article provides details about the features and enhancements made to Azure
2020
> [!IMPORTANT]
2121
> Azure Health Data Services is generally available. For more information, see the [Service Level Agreement (SLA) for Azure Health Data Services](https://azure.microsoft.com/support/legal/sla/health-data-services/v1_1/).
2222
23+
## February 2024
24+
25+
### FHIR service
26+
27+
**Import operation honors ingestion of non-sequential resource versions**
28+
29+
Prior to this change incremental mode in import operation assumed versions to be sequential integers. After this bug fix, versions can be ingested in non-sequential order. For more information, see [Import operation supports non-sequential version ordering for resources](https://github.com/microsoft/fhir-server/pull/3685).
30+
31+
**Revinclude search can reference all resources with wild character**
32+
33+
FHIR service supports wild card searches with revinclude. Adding "*.*" query parameter in revinclude query, it will direct FHIR service to reference all the resources mapped to the source resource.
34+
35+
**Improve FHIR queries response time with performance enhancements**
36+
37+
To improve performance. missing modifier can be specified for a search parameter that is used in sort. For more information, see [improve performance using missing modifier](https://github.com/microsoft/fhir-server/pull/3655)
38+
39+
**Enables counting all versions (historical and soft deleted) of resources**
40+
41+
The query parameter _summary=count and _count=0 can be added to _history endpoint to get count of all versioned resources. This count includes soft deleted resources.
42+
2343
## January 2024
2444

2545
### DICOM service

0 commit comments

Comments
 (0)