Advance Directive Profile
This Resource AdvanceDirective profile is part of the set of resource profiles supported by the API Server used athenaPractice 12.3 products. HL7 FHIR DSTU Release 2.0 does not provide a resource to access advance directives, however this information is essential for the care of patients. We have created an extension of the Basic resource to support this content which can be accessed via the fhir/$AdvanceDirective operation using the same parameter syntax as for search with other resources.
Scope and Usage
This profile is used to define the content that will be returned by the API Server in response to requests to access AdvanceDirective resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
The operations supported by this resource are listed below.
Read Operation
Read operations for this profile of Basic are issued via the $AdvanceDirective operation. To read the content for a specified AdvanceDirective, an application shall perform an HTTP GET, specifying the identifier of the resource being retrieved.
GET [base]/fhir/$AdvanceDirective?_id=[id]{&_format=[json|xml]&_summary=[true|data]}
Read Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the Account resource to retrieve |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
HTTP Response Codes Parameters
| Parameter | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Search Operation
Search operations for this profile of Basic are issued via the $AdvanceDirective operation. To search for content for AdvanceDirective resources, an application shall perform an HTTP GET using the search parameters described below.
GET [base]/fhir/$AdvanceDirective?{search parameters}{&_format=[json|xml]&_summary=[true|data]}
Search Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results AdvanceDirective resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the AthenaHealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| _id (token ) | The ID of the resource |
| _lastUpdated (date ) | The date the resource was last updated. |
| _lastUpdated-fromnow (quantity ) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time , e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| _security (token ) | |
| _tag (token ) | |
| author (reference ) | The author of the advance directive resource. |
| code (token ) | Search by type of advance directive. |
| created (date ) | Date the advance directive was created |
| created-fromnow (token ) | Date the advance directive was created represented as an offset from the current date. |
| encounter (reference ) | Encounter when advance directive was first asserted |
| encounter-or-historical (reference ) | Includes all advance directives that have been signed or are in the specified encounter regardless of signature status. |
| identifier (token ) | The business identifier of the advance directive. |
| subject (reference ) | The patient associated with this advance directive. |
HTTP Response Codes Parameters
| Parameter | Description |
|---|---|
| 200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/advancedirective-profile
| Name | Flags | Card. | Type | Description & Constraints | |
|---|---|---|---|---|---|
  Basic | ∑ | 0..* | Basic | Resource for non-supported content | |
 meta | ∑ | 0..1 | Meta | Metadata about the resource | |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created | |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required ) | ||
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | ||
 advancedirective-category | 0..1 | string | Category | ||
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/advancedirective-category" | ||
 valueString | 1..1 | string | Value of extension | ||
| advancedirective-period | 0..1 | Period | Period | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/advancedirective-period" | ||
 valuePeriod | 1..1 | Period | Value of extension | ||
| advancedirective-encounter | 0..1 | Reference (Reference) | Encounter | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/advancedirective-encounter" | ||
 valueReference | 1..1 | Reference (Reference) | Value of extension | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| identifier | ∑ | 0..* | Identifier | Business identifier | |
| code | ?! ∑ | 1..1 | CodeableConcept | Kind of Resource Binding: Basic Resource Types (example ) | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| coding | ∑ | 0..1 | Coding | Code defined by a terminology system | |
| text | ∑ | 0..1 | string | Plain text representation of the concept | |
| subject | ∑ | 0..1 | Reference (Resource ) | Identifies the focus of this resource | |
| author | ∑ | 0..1 | Reference (Practitioner | Patient | RelatedPerson ) | Who created | |
| created | ∑ | 0..1 | date | When created | |