### US Core Conformance - CapabilityStatement Example

Source: https://build.fhir.org/ig/HL7/US-Core/en/general-requirements

Example snippet demonstrating how a server declares support for the US Core Patient Profile within its CapabilityStatement.

```APIDOC
## CapabilityStatement Example for US Core Patient Profile Support

### Description
This example shows a `CapabilityStatement` resource snippet where a server declares its support for the US Core Patient Profile. This is crucial for clients to understand the profiles and resources the server can handle.

### Method
N/A (This is a configuration example, not an API endpoint)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
```json
{
  "resourceType": "CapabilityStatement",
  "rest": [
    {
      "mode": "Server",
      "resource": [
        {
          "type": "Patient",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ]
        }
      ]
    }
  ]
}
```

#### Response Example
N/A
```

--------------------------------

### US Core Patient Profile Conformance Example

Source: https://build.fhir.org/ig/HL7/US-Core/en/general-requirements

This JSON snippet demonstrates a CapabilityStatement for a server conforming to the US Core Patient Profile. It shows the 'instantiates' element pointing to the US Core Server CapabilityStatement and the 'supportedProfile' element for the US Core Patient Profile. It also includes examples of search parameters and interactions supported for the Patient resource.

```json
{
  "resourceType": "CapabilityStatement",
  "...": "...",
  "instantiates": [
    "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-Server"
  ],
  "...": "...",
  "rest": [
    {
      "mode": "Server",
      "...": "...",
      "resource": [
        ...
        {
          "type": "Patient",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ],
          "interaction": [
            {
              "code": "create"
            },
            {
              "code": "search-type"
            },
            {
              "code": "read"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchRevInclude": [
            "Provenance:target"
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id",
              "type": "token"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
              "type": "token",
              "documentation": "The Client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe Server **SHALL** support both."
            },
            {
              "name": "name",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name",
              "type": "string"
            }

          ],
          "...": "..."
        }
      ]
    }
  ]
}
```

--------------------------------

### FHIR Search by Date Precision Example

Source: https://build.fhir.org/ig/HL7/US-Core/en/general-requirements

Demonstrates how to search using the 'date' search parameter with different precisions for 'date' and 'dateTime' element datatypes. It shows example GET requests for searching by day and by second + time offset.

```HTTP
GET [base]/Patient?family=Shaw&birthdate=2007-03-20
GET [base]Observation?patient=555580&category=laboratory&date=ge2018-03-14T00:00:00-08:00
```

--------------------------------

### Create Device

Source: https://build.fhir.org/ig/HL7/US-Core/us-core-server

Create a new Device resource.

```APIDOC
## POST /Device

### Description
Create a new resource of type Device.

### Method
POST

### Endpoint
/Device

### Parameters
#### Request Body
- **Device** (object) - Required - The new state of the Device resource.

### Request Example
```json
{
  "resourceType": "Device",
  "status": "active",
  "type": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/device-type",
        "code": "heart-monitor"
      }
    ]
  },
  "patient": {
    "reference": "Patient/1"
  }
}
```

### Response
#### Success Response (201)
- **Device** (object) - The newly created Device resource.

#### Response Example
```json
{
  "resourceType": "Device",
  "id": "456",
  "status": "active",
  "type": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/device-type",
        "code": "heart-monitor"
      }
    ]
  },
  "patient": {
    "reference": "Patient/1"
  }
}
```
```

--------------------------------

### Observation.category Example (JSON)

Source: https://build.fhir.org/ig/HL7/US-Core/en/StructureDefinition-head-occipital-frontal-circumference-percentile-definitions

Provides a JSON example for the Observation.category element, illustrating how to represent a user-selected coding.

```json
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "8289-1"
    }
  ]
}
```

--------------------------------

### Provenance Resource Documentation

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Details on the US Core Provenance resource, including conformance expectations, specific documentation, supported profiles, interaction summary, and fetch/search criteria.

```APIDOC
## Provenance Resource

### Description
This section details the US Core Provenance resource, outlining its conformance expectations, specific implementation requirements, and supported profiles. It also summarizes the allowed API interactions and criteria for fetching and searching Provenance resources.

### Conformance Expectation
SHOULD

### Resource Specific Documentation
The US Core Provenance resource SHALL be supported for the following US Core resources:
- AllergyIntolerance
- CarePlan
- CareTeam
- Condition
- Coverage
- Device
- DiagnosticReport
- DocumentReference
- Encounter
- Goal
- Immunization
- MedicationDispense
- MedicationRequest
- Observation
- Patient
- Procedure
- QuestionnaireResponse
- RelatedPerson
- ServiceRequest

If a system receives a provider in `Provenance.agent.who` as free text, they must capture who sent them the information as the organization. On request, they SHALL provide this organization as the source and MAY include the free text provider. Systems that need to know the activity has occurred SHOULD populate the activity.

### Supported Profiles
SHALL support: US Core Provenance Profile

### Profile Interaction Summary
- SHALL support: `read`
- SHOULD support: `vread`, `history-instance`
- MAY support: `create`, `search-type`, `update`, `patch`, `delete`, `history-type`

### Fetch and Search Criteria
A Client SHALL be capable of fetching a Provenance resource using:
`GET [base]/Provenance/[id]`
```

--------------------------------

### FHIR Patient Communication Example

Source: https://build.fhir.org/ig/HL7/US-Core/en/StructureDefinition-us-core-patient-definitions

An example of how to represent historical address context using start and end dates within a FHIR resource. This demonstrates temporal information for addresses.

```json
{
  "start" : "2010-03-23",
  "end" : "2010-07-01"
}
```

--------------------------------

### Search Devices

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Searches for Device resources based on specified parameters.

```APIDOC
## Search Devices

### Description
Searches for Device resources using various query parameters. The `patient` parameter is mandatory for most searches.

### Method
GET

### Endpoint
[base]/Device

### Parameters
#### Query Parameters
- **patient** (reference) - Required - Identifier of the patient to search for devices associated with.
- **status** (token) - Optional - The status of the device (e.g., active, inactive).
- **type** (token) - Optional - The type of the device.
- **_revinclude** (string) - Optional - Include resources that reference this Device (e.g., `Provenance:target`).

### Request Example
```
GET [base]/Device?patient=patient/example-patient-id&status=active
```

### Response
#### Success Response (200)
- **Bundle** (object) - A Bundle resource containing the search results.

#### Response Example
```json
{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "resource": {
        "resourceType": "Device",
        "id": "example-device-1"
        // ... Device resource fields
      }
    },
    {
      "resource": {
        "resourceType": "Device",
        "id": "example-device-2"
        // ... Device resource fields
      }
    }
  ]
}
```
```

--------------------------------

### GET /Observation

Source: https://build.fhir.org/ig/HL7/US-Core/en/scopes

Retrieves Observations. Supports filtering by category.

```APIDOC
## GET /Observation

### Description
Retrieves a collection of Observations, with options to filter by category.

### Method
GET

### Endpoint
`/Observation`

### Query Parameters
- **category** (string) - Optional - Filters the Observations by a specific category code. Examples: `http://hl7.org/fhir/us/core/CodeSystem/us-core-category|cognitive-status`, `http://hl7.org/fhir/us/core/CodeSystem/us-core-category|disability-status`, `http://hl7.org/fhir/us/core/CodeSystem/us-core-category|functional-status`, `http://hl7.org/fhir/us/core/CodeSystem/us-core-category|sdoh`, `http://terminology.hl7.org//CodeSystem-observation-category|social-history`, `http://terminology.hl7.org/CodeSystem/observation-category|activity`, `http://terminology.hl7.org/CodeSystem/observation-category|imaging`, `http://terminology.hl7.org/CodeSystem/observation-category|laboratory`, `http://terminology.hl7.org/CodeSystem/observation-category|procedure`, `http://terminology.hl7.org/CodeSystem/observation-category|survey`, `http://terminology.hl7.org/CodeSystem/observation-category|vital-signs`

### Response
#### Success Response (200)
- **resourceType** (string) - Indicates the resource type, 'Observation'.
- **entry** (array) - An array of Observation resources.

#### Response Example
```json
{
  "resourceType": "Bundle",
  "entry": [
    {
      "resourceType": "Observation",
      "id": "example-id",
      "category": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
              "code": "cognitive-status"
            }
          ]
        }
      ]
    }
  ]
}
```
```

--------------------------------

### MedicationDispense Search Parameter Combinations

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Explains the supported search parameter combinations for the MedicationDispense resource, including required parameters.

```APIDOC
## MedicationDispense Search Parameter Combinations

### Description
This endpoint supports searching for MedicationDispense resources based on specific combinations of parameters. The following combinations are supported with their respective requirements.

### Supported Search Combinations
- **Combination 1**: SHOULD support combination of `patient` and `status`.
- **Combination 2**: SHOULD support combination of `patient` and `status`.
```

--------------------------------

### GET /ServiceRequest

Source: https://build.fhir.org/ig/HL7/US-Core/en/scopes

Retrieves Service Requests. Supports filtering by category.

```APIDOC
## GET /ServiceRequest

### Description
Retrieves a collection of Service Requests, with options to filter by category.

### Method
GET

### Endpoint
`/ServiceRequest`

### Query Parameters
- **category** (string) - Optional - Filters the Service Requests by a specific category code. Examples: `http://hl7.org/fhir/us/core/CodeSystem/us-core-category|functional-status`, `http://snomed.info/sct|surgical-procedure`

### Response
#### Success Response (200)
- **resourceType** (string) - Indicates the resource type, 'ServiceRequest'.
- **entry** (array) - An array of ServiceRequest resources.

#### Response Example
```json
{
  "resourceType": "Bundle",
  "entry": [
    {
      "resourceType": "ServiceRequest",
      "id": "example-id",
      "category": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
              "code": "functional-status"
            }
          ]
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Questionnaire Resource Documentation

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Details on the US Core Questionnaire resource, including conformance expectations, specific documentation, supported profiles, interaction summary, and fetch/search criteria.

```APIDOC
## Questionnaire Resource

### Description
This section outlines the US Core Questionnaire resource, detailing how it's used for screening and assessment instruments, its conformance expectations, supported profiles, interaction summary, and criteria for fetching Questionnaire resources.

### Conformance Expectation
SHOULD

### Resource Specific Documentation
US Core defines two ways to represent questions and responses to screening and assessment instruments:
- Observation: US Core Observation Screening Assessment Profile
- Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile

US Core Servers SHALL support the US Core Observation Screening Assessment Profile and SHOULD support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile.

### Supported Profiles
SHALL support: SDC Base Questionnaire Profile

### Profile Interaction Summary
- SHOULD support: `read`, `vread`
- MAY support: `create`, `search-type`, `update`, `patch`, `delete`, `history-instance`, `history-type`

### Fetch and Search Criteria
A Client SHOULD be capable of fetching a Questionnaire resource using:
`GET [base]/Questionnaire/[id]`
```

--------------------------------

### GET /DocumentReference

Source: https://build.fhir.org/ig/HL7/US-Core/en/scopes

Retrieves Document References. Supports filtering by category.

```APIDOC
## GET /DocumentReference

### Description
Retrieves a collection of Document References, with options to filter by category.

### Method
GET

### Endpoint
`/DocumentReference`

### Query Parameters
- **category** (string) - Optional - Filters the Document References by a specific category code. Examples: `http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category|clinical-note`

### Response
#### Success Response (200)
- **resourceType** (string) - Indicates the resource type, 'DocumentReference'.
- **entry** (array) - An array of DocumentReference resources.

#### Response Example
```json
{
  "resourceType": "Bundle",
  "entry": [
    {
      "resourceType": "DocumentReference",
      "id": "example-id",
      "category": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
              "code": "clinical-note"
            }
          ]
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Supported Search Parameters

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Details the search parameters supported for resources within the US Core Implementation Guide, including their types, definitions, and conformance requirements.

```APIDOC
## Supported Search Parameters

This section lists the search parameters supported by the US Core IG for various resources, along with their details and conformance.

### Search Parameter: _id

- **Name**: `_id`
- **Type**: `token`
- **Definition**: `http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-id`
- **Expectation**: SHALL

### Search Parameter: name

- **Name**: `name`
- **Type**: `string`
- **Definition**: `http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-name`
- **Expectation**: SHOULD

### Search Parameter: patient

- **Name**: `patient`
- **Type**: `reference`
- **Definition**: `http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-patient`
- **Expectation**: SHOULD
- **Documentation**: The client **SHALL** provide at least an `id` value and **MAY** provide both the Type and `id` values. The server **SHALL** support both.

### Search Parameter Combinations

- **Combination 1**: Requires `patient` and `category`
  - **Expectation**: SHALL

- **Combination 2**: Requires `patient` and `status`
  - **Expectation**: SHOULD

```

--------------------------------

### GET /DiagnosticReport

Source: https://build.fhir.org/ig/HL7/US-Core/en/scopes

Retrieves Diagnostic Reports. Supports filtering by category.

```APIDOC
## GET /DiagnosticReport

### Description
Retrieves a collection of Diagnostic Reports, with options to filter by category.

### Method
GET

### Endpoint
`/DiagnosticReport`

### Query Parameters
- **category** (string) - Optional - Filters the Diagnostic Reports by a specific category code. Examples: `http://loinc.org|LP29708-2`, `http://loinc.org|LP7839-6`, `http://terminology.hl7.org/CodeSystem/v2-0074|LAB`

### Response
#### Success Response (200)
- **resourceType** (string) - Indicates the resource type, 'DiagnosticReport'.
- **entry** (array) - An array of DiagnosticReport resources.

#### Response Example
```json
{
  "resourceType": "Bundle",
  "entry": [
    {
      "resourceType": "DiagnosticReport",
      "id": "example-id",
      "category": [
        {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "LP7839-6"
            }
          ]
        }
      ]
    }
  ]
}
```
```

--------------------------------

### GET /Device/{id}

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Retrieves a specific Device resource by its ID.

```APIDOC
## GET /Device/{id}

### Description
Retrieves a specific Device resource by its unique identifier.

### Method
GET

### Endpoint
[base]/Device/[id]

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the Device resource.

### Response
#### Success Response (200)
- **Device** (object) - The Device resource.

#### Response Example
```json
{
  "resourceType": "Device",
  "id": "example-device-id",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-device"
    ]
  }
  // ... other Device resource fields
}
```
```

--------------------------------

### US Core Coverage Resource Interactions and Search

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Documentation for the Coverage resource, including supported interactions, fetch criteria, and search parameters.

```APIDOC
## US Core Coverage Resource

### Description
This section describes the Coverage resource within the US Core FHIR Implementation Guide, detailing supported profiles, interactions, and search capabilities.

### Conformance
- Conformance Expectation: SHOULD
- Supported Profiles:
  - SHALL support: US Core Coverage Profile

### Profile Interaction Summary
- SHALL support: `search-type`, `read`
- SHOULD support: `vread`, `history-instance`
- MAY support: `create`, `update`, `patch`, `delete`, `history-type`

### Fetch and Search Criteria
- **Fetch Coverage Resource:** A Client SHALL be capable of fetching a Coverage resource using:
  `GET [base]/Coverage/[id]`
- **Search Criteria:** A Client SHOULD be capable of supporting the following _revincludes:
  `Provenance:target` - `GET [base]/Coverage?[parameter=value]&_revinclude=Provenance:target`

### Search Parameter Summary
- **SHALL** support: `patient` (reference)

#### Query Parameters
- **patient** (reference) - SHALL - The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
```

--------------------------------

### Goal Resource

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Search parameter details for the Goal resource, including supported parameters and their requirements.

```APIDOC
## Goal Resource Search Parameters

### Description

Details on search parameters for the Goal resource, including requirements for 'lifecycle-status', 'patient', and 'target-date'.

### Search Parameter Requirements (When Used Alone or in Combination)

- **lifecycle-status** (token): Client SHALL provide at least a code value and MAY provide both the system and code values. Server SHALL support both.
- **patient** (reference): Client SHALL provide at least an id value and MAY provide both the Type and id values. Server SHALL support both.
- **target-date** (date): Client SHALL provide a value precise to the *day*. Server SHALL support a value precise to the *day*.
```

--------------------------------

### SMART Scopes Format Example

Source: https://build.fhir.org/ig/HL7/US-Core/en/scopes

This example demonstrates the syntax for SMART scopes, specifying access permissions for FHIR resources. It includes a patient-specific scope for read and search access to laboratory observations only.

```text
patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory
```

--------------------------------

### QuestionnaireResponse Resource Documentation

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Details on the US Core QuestionnaireResponse resource, including conformance expectations, specific documentation, supported profiles, interaction summary, and fetch/search criteria.

```APIDOC
## QuestionnaireResponse Resource

### Description
This section describes the US Core QuestionnaireResponse resource, covering its role in representing screening and assessment responses, conformance expectations, supported profiles, interaction summary, and criteria for fetching QuestionnaireResponse resources, including supported _revincludes.

### Conformance Expectation
SHOULD

### Resource Specific Documentation
US Core defines two ways to represent questions and responses to screening and assessment instruments:
- Observation: US Core Observation Screening Assessment Profile
- Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile

US Core Servers SHALL support the US Core Observation Screening Assessment Profile and SHOULD support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile.

### Supported Profiles
SHALL support: US Core QuestionnaireResponse Profile

### Profile Interaction Summary
- SHOULD support: `search-type`, `read`, `vread`, `history-instance`
- MAY support: `create`, `update`, `patch`, `delete`, `history-type`

### Fetch and Search Criteria
A Client SHOULD be capable of fetching a QuestionnaireResponse resource using:
`GET [base]/QuestionnaireResponse/[id]`
A Client SHOULD be capable of supporting the following _revincludes: Provenance:target
```

--------------------------------

### GET /system/ServiceRequest

Source: https://build.fhir.org/ig/HL7/US-Core/en/scopes

Retrieves a list of system-level ServiceRequests, optionally filtered by category.

```APIDOC
## GET /system/ServiceRequest

### Description
Retrieves a list of ServiceRequests available at the system level. This endpoint supports filtering by the 'category' query parameter.

### Method
GET

### Endpoint
/system/ServiceRequest

### Parameters
#### Query Parameters
- **category** (string) - Optional - A codeable concept specifying the category of the ServiceRequest. Example: `http://snomed.info/sct|surgical-procedure`

### Request Example
```
GET /system/ServiceRequest?category=http://snomed.info/sct|surgical-procedure
```

### Response
#### Success Response (200)
- **ServiceRequest[]** (array) - An array of ServiceRequest resources.

#### Response Example
```json
[
  {
    "resourceType": "ServiceRequest",
    "id": "system-sr-1",
    "status": "active",
    "intent": "order",
    "category": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "12345",
            "display": "Surgical Procedure"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://www.ama-assn.org/ссер",
          "code": "2747000"
        }
      ],
      "text": "Appendectomy"
    }
  }
]
```
```

--------------------------------

### POST /Practitioner

Source: https://build.fhir.org/ig/HL7/US-Core/us-core-server

Creates a new Practitioner resource. Supports JSON and XML formats, and includes options for pretty printing and element selection.

```APIDOC
## POST /Practitioner

### Description
Creates a new Practitioner resource.

### Method
POST

### Endpoint
/Practitioner

### Parameters
#### Query Parameters
- **_summary** (string) - Optional - Allows summarizing the resource in the response.
- **_format** (string) - Optional - Specifies the response format (e.g., `application/fhir+json`).
- **_pretty** (boolean) - Optional - Requests a pretty-printed JSON response.
- **_elements** (string) - Optional - Specifies which elements to include in the response.

#### Request Body
- **Practitioner** (Practitioner) - Required - The practitioner resource to be created.

### Request Example
```json
{
  "resourceType": "Practitioner",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml">...</div>"
  },
  "identifier": [
    {
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": "1234567890"
    }
  ],
  "active": true,
  "name": [
    {
      "use": "official",
      "family": "Smith",
      "given": [
        "John",
        "Adam"
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "(555) 555-1234"
    }
  ],
  "address": [
    {
      "city": "Seattle",
      "state": "WA",
      "postalCode": "98101",
      "country": "USA"
    }
  ]
}
```

### Response
#### Success Response (200)
- **Practitioner** (Practitioner) - The created practitioner resource.
- **ETag** (string) - Version from Resource.meta.version as a weak ETag.

#### Response Example
```json
{
  "resourceType": "Practitioner",
  "id": "example",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-10-27T10:00:00.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml">...</div>"
  },
  "identifier": [
    {
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": "1234567890"
    }
  ],
  "active": true,
  "name": [
    {
      "use": "official",
      "family": "Smith",
      "given": [
        "John",
        "Adam"
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "(555) 555-1234"
    }
  ],
  "address": [
    {
      "city": "Seattle",
      "state": "WA",
      "postalCode": "98101",
      "country": "USA"
    }
  ]
}
```

#### Error Response (default)
- **OperationOutcome** (OperationOutcome) - Details about the error.
```

--------------------------------

### GET /user/ServiceRequest

Source: https://build.fhir.org/ig/HL7/US-Core/en/scopes

Retrieves a list of ServiceRequests for the authenticated user, optionally filtered by category.

```APIDOC
## GET /user/ServiceRequest

### Description
Retrieves a list of ServiceRequests associated with the current user. This endpoint supports filtering by the 'category' query parameter.

### Method
GET

### Endpoint
/user/ServiceRequest

### Parameters
#### Query Parameters
- **category** (string) - Optional - A codeable concept specifying the category of the ServiceRequest. Example: `http://snomed.info/sct|surgical-procedure`

### Request Example
```
GET /user/ServiceRequest?category=http://snomed.info/sct|surgical-procedure
```

### Response
#### Success Response (200)
- **ServiceRequest[]** (array) - An array of ServiceRequest resources.

#### Response Example
```json
[
  {
    "resourceType": "ServiceRequest",
    "id": "example-sr-1",
    "status": "active",
    "intent": "order",
    "category": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "12345",
            "display": "Surgical Procedure"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://www.ama-assn.org/ссер",
          "code": "2747000"
        }
      ],
      "text": "Appendectomy"
    }
  }
]
```
```

--------------------------------

### Location Resource API

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Documentation for the Location resource, including supported profiles, interactions, and search parameters according to the US Core Implementation Guide.

```APIDOC
## GET /Location/[id]

### Description
Fetches a Location resource by its ID.

### Method
GET

### Endpoint
[base]/Location/[id]

### Parameters
#### Path Parameters
- **id** (id) - Required - The logical identifier for the Location resource.

#### Query Parameters
- **address** (string) - SHALL - Search by the location's address.
- **name** (string) - SHALL - Search by the location's name.
- **address-city** (string) - SHOULD - Search by the city in the location's address.
- **address-postalcode** (string) - SHOULD - Search by the postal code in the location's address.
- **address-state** (string) - SHOULD - Search by the state in the location's address.

### Request Example
```json
{
  "example": "GET /fhir/Location/example-location-id"
}
```

### Response
#### Success Response (200)
- **Location** (Location) - The Location resource.

#### Response Example
```json
{
  "resourceType": "Location",
  "id": "example-location-id",
  "address": [
    {
      "line": ["123 Main St"],
      "city": "Anytown",
      "state": "CA",
      "postalCode": "90210"
    }
  ],
  "name": "Example Clinic"
}
```
```

--------------------------------

### FHIR US Core Patient Resource Declaration

Source: https://build.fhir.org/ig/HL7/US-Core/en/MedicationRequest-medicationrequest-contained-oral-axid

Declares an example FHIR resource conforming to the US Core Implementation Guide specification for a Patient resource. This is a common pattern for identifying US-specific patient data.

```N3
<http://hl7.org/fhir/us/core/Patient/example> a fhir:us .
```

--------------------------------

### Practitioner Resource Documentation

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Details on the Practitioner resource within the US Core profile, including supported search parameters and interactions.

```APIDOC
## Practitioner Resource

### Description
This section details the US Core Practitioner resource, including its search parameters and supported operations.

### Supported Search Parameters

#### `_id`
- **Type**: token
- **Expectation**: SHOULD
- **Definition**: http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-id

#### `identifier`
- **Type**: token
- **Expectation**: SHALL
- **Description**: The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
- **Definition**: http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier

#### `name`
- **Type**: string
- **Expectation**: SHALL
- **Definition**: http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-name

### Supported Operations

#### Create
- **Expectation**: MAY

#### Search by Type (`search-type`)
- **Expectation**: SHALL

#### Read (`read`)
- **Expectation**: SHALL

#### Version Read (`vread`)
- **Expectation**: SHOULD

#### Update (`update`)
- **Expectation**: MAY

#### Patch (`patch`)
- **Expectation**: MAY

#### Delete (`delete`)
- **Expectation**: MAY

#### History Instance (`history-instance`)
- **Expectation**: SHOULD

#### History Type (`history-type`)
- **Expectation**: MAY

### Supported Profiles

- **PractitionerRole**: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole|8.0.0 (SHALL)
  - **Documentation**: Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However the US Core PractitionerRole Profile SHOULD be used as the default profile if referenced by another US Core profile.
```

--------------------------------

### Observation Code Example (FHIR)

Source: https://build.fhir.org/ig/HL7/US-Core/en/StructureDefinition-head-occipital-frontal-circumference-percentile-definitions

This example shows how to represent the code for an observation, specifically for a vital sign measurement like '8289-1' (Systolic blood pressure). It includes the system (LOINC) and the code itself.

```json
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8289-1"
    }
  ]
}
```

--------------------------------

### US Core Device Resource Details

Source: https://build.fhir.org/ig/HL7/US-Core/en/CapabilityStatement-us-core-client

Details on the Device resource, including specific requirements for UDI information and supported search parameters.

```APIDOC
## US Core Device Resource

### Description
This section outlines the Device resource within the US Core FHIR Implementation Guide, focusing on UDI representation and supported interactions and search capabilities.

### Resource Specific Documentation
- Implantable medical devices with UDI information SHALL represent the UDI code in `Device.udiCarrier.carrierHRF`.
- All five UDI-PI elements present in the UDI code SHALL be represented in the corresponding US Core Implantable Device Profile element.
- If UDI is not present, manufacturer and/or model number SHOULD be included:
  - `manufacturer` -> `Device.manufacturer`
  - `model` -> `Device.model`
- Servers SHOULD support query by `Device.type`.

### Supported Profiles
- SHALL support: US Core Implantable Device Profile

### Profile Interaction Summary
- SHALL support: `search-type`, `read`
- SHOULD support: `vread`, `history-instance`
- MAY support: `create`, `update`, `patch`, `delete`, `history-type`

### Fetch and Search Criteria
- **Fetch Device Resource:** A Client SHALL be capable of fetching a Device resource using:
  `GET [base]/Device/[id]`
```

--------------------------------

### FHIR US Core Practitioner Resource Declaration

Source: https://build.fhir.org/ig/HL7/US-Core/en/MedicationRequest-medicationrequest-contained-oral-axid

Declares an example FHIR resource conforming to the US Core Implementation Guide specification for a Practitioner resource. This pattern is used to identify US-specific healthcare provider data.

```N3
<http://hl7.org/fhir/us/core/Practitioner/practitioner-1> a fhir:us .
```