Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #5549 ccda documentation #5550

Merged
merged 1 commit into from
Jun 26, 2022
Merged

Fixes #5549 ccda documentation #5550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion FHIR_README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,6 @@ It is recommended that native applications follow best practices for native clie
- History of Procedures
- Relevant DX Tests / LAB Data
- Functional Status
- Vital Signs
- Progress Notes
- Procedure Notes
- Laboratory Report Narrative
Expand All @@ -223,6 +222,7 @@ It is recommended that native applications follow best practices for native clie
- Immunizations
- Social History
- Medical Equipment
- Vital Signs (shows the latest vitals recorded for the patient)

- CCD is generated on demand, saved off in patient's record under the CCDA category
- Requires following standard FHIR authorization
Expand All @@ -232,6 +232,11 @@ It is recommended that native applications follow best practices for native clie
- Or xml file can be uploaded as a document into OpenEMR to view in a human readable format
- Due to browser security restrictions XSL file must be in same directory as ccd document to view.
- link out to swagger location on where to build file
- If no start date is provided it will retrieve all records in the patient history up to the end date
- If no end date is provided it will retrieve all records connected to encounters starting from
the start date
- If a records for a specific service date are desired, make the start date and end date the same day in YYYY-MM-DD format.
- Dates must be specified in least specifity to most specifity for wildcard like operations IE YYYY for the beginning of the year for start date or ending of the year for end date, YYYY-MM for the beginning of the month for start date and end of the month for end date, etc.

## For Developers

Expand Down
4 changes: 2 additions & 2 deletions _rest_routes.inc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8642,7 +8642,7 @@
/**
* @OA\Get(
* path="/fhir/Document/{id}/Binary",
* description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
* description="Used for downloading binary documents generated either with BULK FHIR Export or with the $docref CCD export operation. Documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
* tags={"fhir"},
* @OA\Parameter(
* name="id",
Expand All @@ -8655,7 +8655,7 @@
* ),
* @OA\Response(
* response="200",
* description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>"
* description="The documentation for working with BULK FHIR or $docref document exports can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>"
* ),
* @OA\Response(
* response="400",
Expand Down
4 changes: 2 additions & 2 deletions swagger/openemr-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4300,7 +4300,7 @@ paths:
get:
tags:
- fhir
description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
description: 'Used for downloading binary documents generated either with BULK FHIR Export or with the $docref CCD export operation. Documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
parameters:
-
name: id
Expand All @@ -4311,7 +4311,7 @@ paths:
type: string
responses:
'200':
description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
description: 'The documentation for working with BULK FHIR or $docref document exports can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
'400':
$ref: '#/components/responses/badrequest'
'401':
Expand Down