Skip to content

Commit 16a2404

Browse files
v-rachitshv-rachitsh
committed
Update uscore.md
1 parent 034cc14 commit 16a2404

2 files changed

Lines changed: 180 additions & 0 deletions

File tree

‎articles/healthcare-apis/fhir/toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ items:
4545
- name: Customer-managed keys
4646
expanded: false
4747
items:
48+
- name: US Core
49+
href: uscore.md
4850
- name: Configure customer-managed keys
4951
href: configure-customer-managed-keys.md
5052
- name: Customer-managed keys best practices

‎articles/healthcare-apis/fhir/uscore.md‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
---
2+
title: US Core
3+
description: Overview of US Core in Azure Health Data Services FHIR
4+
author: evachen96
5+
ms.author: evach
6+
ms.service: healthcare-apis
7+
ms.topic: overview #Required; leave this attribute/value as-is.
8+
ms.date: 10/10/2025
9+
10+
---
11+
12+
# US Core
13+
14+
The HL7 US Core Implementation Guide (US Core IG) is a set of rules and best practices that help healthcare providers share patient information safely and efficiently across the United States. The Azure Health Data Services FHIR server supports the following US Core versions:
15+
16+
- [US Core 3.1.1](https://hl7.org/fhir/us/core/STU3.1.1/index.html)
17+
- [US Core 6.1.0](https://www.hl7.org/fhir/us/core/STU6.1/ImplementationGuide-hl7.fhir.us.core.html)
18+
19+
Note that the FHIR service doesn't store any profiles from implementation guides by default. You'll need to load them into the FHIR service. Follow [storing profiles instructions](./fhir/store-profiles-in-fhir.md) to store the relevant profiles for your desired US Core version.
20+
21+
## US Core 6.1.0
22+
## `$docref` operation
23+
The [$docref operation](https://www.hl7.org/fhir/us/core/STU6.1/OperationDefinition-docref.html), as defined as part of US Core 6.1.0, is used to return all the references to documents related to a patient. A `searchset` Bundle containing DocumentReference resources for the patient is returned.
24+
25+
### `$docref` parameters
26+
|Parameter|Description|
27+
|---|---|
28+
|patient|The ID of the patient resource.|
29+
|start|The start date-time of the date range relates to care dates, not record currency dates. |
30+
|end| The end date-time of the date range relates to care dates, not record currency dates. |
31+
|type| The type relates to document type.|
32+
33+
Note that on-demand and profile parameters aren't currently supported.
34+
35+
### Example `$docref` requests
36+
37+
**Request the latest CCD for a patient using GET syntax**
38+
39+
```
40+
GET [base]/DocumentReference/$docref?patient=123
41+
```
42+
43+
**Request the latest CCD for a patient using POST syntax**
44+
45+
```
46+
POST [base]/DocumentReference/$docref
47+
```
48+
POST request body:
49+
```json
50+
{
51+
"resourceType": "Parameters",
52+
"id": "get-ccd123",
53+
"parameter": [
54+
{
55+
"name": "patient",
56+
"valueId": "123"
57+
}
58+
]
59+
}
60+
```
61+
62+
**Request Discharge Summaries for 2019 using GET syntax**
63+
64+
```
65+
GET [base]/DocumentReference/$docref?patient=123&start=2019-01-01&end=2019-12-31&type=https://loinc.org|18842-5
66+
```
67+
68+
**Request Discharge Summaries for 2019 using POST syntax**
69+
70+
```
71+
POST [base]/DocumentReference/$docref
72+
```
73+
POST request body:
74+
```json
75+
{
76+
"resourceType": "Parameters",
77+
"id": "get-docs",
78+
"parameter": [
79+
{
80+
"name": "patient",
81+
"valueId": "123"
82+
},
83+
{
84+
"name": "start",
85+
"valueDateTime": "2019-01-01"
86+
},
87+
{
88+
"name": "end",
89+
"valueDateTime": "2019-12-31"
90+
},
91+
{
92+
"name": "type",
93+
"valueCoding": {
94+
"system": "https://loinc.org",
95+
"code": "18842-5",
96+
"display": "Discharge summary"
97+
}
98+
}
99+
]
100+
}
101+
```
102+
103+
## `$expand` operation
104+
The [$expand operation](https://hl7.org/fhir/R4/valueset-operation-expand.html), as defined as part of US Core 6.1.0, is used to determine the values in a ValueSet.
105+
106+
### `$expand` parameters
107+
|Parameter|Description|
108+
|---|---|
109+
|url|Canonical reference of the value set.|
110+
| valueSet| Provide the value set directly as part of the request.|
111+
112+
Note: other $expand parameters beyond this list aren't currently supported.
113+
114+
### Example `$expand` requests
115+
116+
**Expanding a value set by its canonical URL using GET syntax**
117+
118+
```
119+
GET [base]/ValueSet/$expand?url=http://acme.com/fhir/ValueSet/23
120+
```
121+
122+
**Expanding a value set by its canonical URL using POST syntax**
123+
124+
```
125+
POST [base]/ValueSet/$expand
126+
```
127+
POST request body:
128+
```json
129+
{
130+
"resourceType": "Parameters",
131+
"id": "expand",
132+
"parameter": [
133+
{
134+
"name": "url",
135+
"value": "http://acme.com/fhir/ValueSet/23"
136+
}
137+
]
138+
}
139+
```
140+
141+
**Expanding a value set already registered on the server using GET syntax**
142+
143+
```
144+
GET [base]/ValueSet/23/$expand
145+
```
146+
147+
**Expanding a value set in the parameters using POST syntax**
148+
149+
```
150+
POST [base]/ValueSet/$expand
151+
```
152+
POST request body:
153+
```json
154+
{
155+
"resourceType": "Parameters",
156+
"id": "expand",
157+
"parameter": [
158+
{
159+
"name": "valueSet",
160+
"resource": {
161+
"resourceType": "ValueSet",
162+
<value set details>
163+
}
164+
}
165+
]
166+
}
167+
```
168+
169+
<!-->
170+
### US Core 6 test data
171+
We have provided [sample test data](https://github.com/Azure-Samples/azure-health-data-and-ai-samples/tree/main/samples/USCore6-test-data) that can be used for US Core 6 testing.
172+
173+
Note: Samples are open-source code, and you should review the information and licensing terms on GitHub before using it. They are not part of the Azure Health Data Service and are not supported by Microsoft Support.
174+
-->
175+
176+
Medical device disclaimer: Microsoft products and services (1) aren't designed, intended, or made available as a medical device, and (2) aren't designed or intended to be a substitute for professional medical advice, diagnosis, treatment, or judgment and shouldn't be used to replace or as a substitute for professional medical advice, diagnosis, treatment, or judgment. Customers/partners are responsible for ensuring solutions comply with applicable laws and regulations. 
177+
178+
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

0 commit comments

Comments
 (0)