Skip to content

Commit 3853a1c

Browse files
committed
Update profile storing doc for clarity
Update profile storing doc for clarity
1 parent 647cc46 commit 3853a1c

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

articles/healthcare-apis/azure-api-for-fhir/store-profiles-in-fhir.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For example:
3535
- `http://hl7.org/fhir/StructureDefinition/bmi` is another base profile that defines how to represent Body Mass Index (BMI) observations.
3636
- `http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance` is a US Core profile that sets minimum expectations for `AllergyIntolerance` resource associated with a patient, and it identifies mandatory fields such as extensions and value sets.
3737

38-
When a resource conforms to a profile, the profile is specified inside the `profile` element of the resource.
38+
When a resource conforms to a profile, the profile is specified inside the `profile` element of the resource. Below you can see an example of the beginning of a 'Patient' resource which has http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient profile.
3939

4040
```json
4141
{
@@ -53,7 +53,7 @@ When a resource conforms to a profile, the profile is specified inside the `prof
5353
> [!NOTE]
5454
> Profiles must build on top of the base resource and cannot conflict with the base resource. For example, if an element has a cardinality of 1..1, the profile cannot make it optional.
5555

56-
Profiles are also specified by various Implementation Guides. Some common Implementation Guides are:
56+
Profiles are also specified by various Implementation Guides (IGs). Some common IGs are listed below. You can go to the specific IG site to learn more about the IG and the profiles defined within it.
5757

5858
|Name |URL
5959
|---- |----
@@ -62,6 +62,9 @@ CARIN Blue Button |<http://hl7.org/fhir/us/carin-bb/>
6262
Da Vinci Payer Data Exchange |<http://hl7.org/fhir/us/davinci-pdex/>
6363
Argonaut |<http://www.fhir.org/guides/argonaut/pd/>
6464

65+
> [!NOTE]
66+
> The Azure API for FHIR does not store any profiles from implementation guides by default. You will need to load them into the Azure API for FHIR.
67+
6568
## Accessing profiles and storing profiles
6669

6770
### Storing profiles
@@ -79,7 +82,7 @@ To store profiles in Azure API for FHIR, you can `POST` the `StructureDefinition
7982
}
8083
```
8184

82-
For example, if you'd like to store the `us-core-allergyintolerance` profile, you'd do the following:
85+
For example, if you'd like to store the `us-core-allergyintolerance` profile, you'd use the following rest command with the US Core allergy intolerance profile in the body. We have included a snippet of this profile for the example.
8386

8487
```rest
8588
POST https://myAzureAPIforFHIR.azurehealthcareapis.com/StructureDefinition?url=http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
@@ -112,7 +115,7 @@ POST https://myAzureAPIforFHIR.azurehealthcareapis.com/StructureDefinition?url=h
112115
],
113116
"description" : "Defines constraints and extensions on the AllergyIntolerance resource for the minimal set of data to query and retrieve allergy information.",
114117
```
115-
For more examples, see the [US Core sample REST file](https://github.com/microsoft/fhir-server/blob/main/docs/rest/PayerDataExchange/USCore.http) on the open-source site that walks through storing US Core profiles.
118+
For more examples, see the [US Core sample REST file](https://github.com/microsoft/fhir-server/blob/main/docs/rest/PayerDataExchange/USCore.http) on the open-source site that walks through storing US Core profiles. To get the most up to date profiles you should get the profiles directly from HL7 and the implementation guide that defines them.
116119

117120
### Viewing profiles
118121

articles/healthcare-apis/fhir/store-profiles-in-fhir.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For example:
3838
- `http://hl7.org/fhir/StructureDefinition/bmi` is another base profile that defines how to represent Body Mass Index (BMI) observations.
3939
- `http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance` is a US Core profile that sets minimum expectations for `AllergyIntolerance` resource associated with a patient, and it identifies mandatory fields such as extensions and value sets.
4040

41-
When a resource conforms to a profile, the profile is specified inside the `profile` element of the resource.
41+
When a resource conforms to a profile, the profile is specified inside the `profile` element of the resource. Below you can see an example of the beginning of a 'Patient' resource which has http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient profile.
4242

4343
```json
4444
{
@@ -56,7 +56,7 @@ When a resource conforms to a profile, the profile is specified inside the `prof
5656
> [!NOTE]
5757
> Profiles must build on top of the base resource and cannot conflict with the base resource. For example, if an element has a cardinality of 1..1, the profile cannot make it optional.
5858

59-
Profiles are also specified by various Implementation Guides. Some common Implementation Guides are:
59+
Profiles are also specified by various Implementation Guides (IGs). Some common IGs are listed below. You can go to the specific IG site to learn more about the IG and the profiles defined within it.
6060

6161
|Name |URL
6262
|---- |----
@@ -65,6 +65,9 @@ CARIN Blue Button |<http://hl7.org/fhir/us/carin-bb/>
6565
Da Vinci Payer Data Exchange |<http://hl7.org/fhir/us/davinci-pdex/>
6666
Argonaut |<http://www.fhir.org/guides/argonaut/pd/>
6767

68+
> [!NOTE]
69+
> The FHIR service does not store any profiles from implementation guides by default. You will need to load them into the FHIR service.
70+
6871
## Accessing profiles and storing profiles
6972

7073
### Storing profiles
@@ -82,7 +85,7 @@ To store profiles to the FHIR server, you can `POST` the `StructureDefinition` w
8285
}
8386
```
8487

85-
For example, if you'd like to store the `us-core-allergyintolerance` profile, you'd do the following:
88+
For example, if you'd like to store the `us-core-allergyintolerance` profile, you'd use the following rest command with the US Core allergy intolerance profile in the body. We have included a snippet of this profile for the example.
8689

8790
```rest
8891
POST https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/StructureDefinition?url=http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
@@ -115,7 +118,7 @@ POST https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/StructureDefi
115118
],
116119
"description" : "Defines constraints and extensions on the AllergyIntolerance resource for the minimal set of data to query and retrieve allergy information.",
117120
```
118-
For more examples, see the [US Core sample REST file](https://github.com/microsoft/fhir-server/blob/main/docs/rest/PayerDataExchange/USCore.http) on the open-source site that walks through storing US Core profiles.
121+
For more examples, see the [US Core sample REST file](https://github.com/microsoft/fhir-server/blob/main/docs/rest/PayerDataExchange/USCore.http) on the open-source site that walks through storing US Core profiles. To get the most up to date profiles you should get the profiles directly from HL7 and the implementation guide that defines them.
119122

120123
### Viewing profiles
121124

0 commit comments

Comments
 (0)