Posting Profile
This Resource Posting 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 patient payments, however this information is essential for practice management. We have created an extension of the Basic resource to support this content which can be accessed via the fhir/$Posting operation using the same parameter syntax as for search with other resources. The resource is an extension of the Basic resource and can be accessed via the fhir/$Posting 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 Posting 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.
Supported Operations
The operations supported by this resource are listed below.
Read Operation
Read operations for this profile of Basic are issued via the $Posting operation. To read the content for a specified Posting, an application shall perform an HTTP GET, specifying the identifier of the resource being retrieved.
GET [base]/fhir/$Posting?_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 Posting 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. |
Read Operation HTTP Response Codes
| Response Code | 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 $Posting operation. To search for content for Posting resources, an application shall perform an HTTP GET using the search parameters described below.
GET [base]/fhir/$Posting?{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 Posting 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 ) | |
| code (token ) | Search by type. NOTE: All Posting resources have the code value fixed to invoice  ,
which makes it of little value as a search parameter.
|
| batch (token ) | The payment batch associated with the payment. |
| created (date ) | Date the payment was created |
| created-fromnow (token ) | Date the payment was created represented as an offset from the current date. |
| identifier (token ) | The business identifier of this payment. |
| patientVisitId (token ) | The id of this visit associated with this payment. |
| payer (string ) | The name of the payer associated with this payment. |
| subject (reference ) | The patient associated with this payment. |
Search Operation HTTP Response Codes
| Response Code | 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. |
Create Operation
Create operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new Posting resource, an application must perform an HTTP POST, specifying the content of the resource in the body of the request.
Post payment to billing account for the patient referenced by patient parameter below.
POST [base]/fhir/$PostPayment?{_format=[json|xml]}
Create Operation Parameters
| Parameter | Description |
|---|---|
| [_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. |
Create Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 201 Created | The resource was created at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes. |
| 400 Bad Request | The resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
| 422 Unprocessable Entity | The proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
Delete Operation
Delete operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To remove a Posting resource, an application must perform an HTTP DELETE, specifying the id of the Posting resource to be removed, Patient Visit Id and a TicketNo.
DELETE [base]/fhir/$deletePayment?{_format=[json|xml]}
Delete Operation Parameters
| Parameter | Description |
|---|---|
| [_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. |
Delete Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The requested resource is deleted. |
| 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. |
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/posting-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 | ||
 posting-batch | 1..1 | integer | Batch id | ||
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/posting-batch" | ||
 valueInteger | 1..1 | integer | Value of extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 1..1 | Extension | Extension | ||
| extension | 1..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| posting-payerName | 0..1 | string | Payer name | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/posting-payerName" | ||
| valueString | 1..1 | string | Value of extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| extension | 0..1 | Extension | Extension | ||
| posting-patientVisitId | 0..1 | integer | Patient Visit Id | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/posting-patientVisitId" | ||
| valueInteger | 1..1 | integer | 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 ) | |
 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 | |