Skip to content

Commit 9231e39

Browse files
authored
Fix the swagger file Fixes openemr#9702 (openemr#9884)
Fixes openemr#9702 swagger file which wasn't updated properly on the merge.
1 parent 1ddd09f commit 9231e39

File tree

1 file changed

+47
-37
lines changed

1 file changed

+47
-37
lines changed

swagger/openemr-api.yaml

Lines changed: 47 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5161,6 +5161,53 @@ paths:
51615161
security:
51625162
-
51635163
openemr_auth: { }
5164+
/fhir/DocumentReference/$docref:
5165+
post:
5166+
tags:
5167+
- fhir
5168+
description: "The $docref operation is used to request the server generates a document based on the specified parameters. If no additional parameters are specified then a DocumentReference to the patient's most current Clinical Summary of Care Document (CCD) is returned. The document itself is retrieved using the DocumentReference.content.attachment.url element. See <a href='http://hl7.org/fhir/us/core/OperationDefinition-docref.html' target='_blank' rel='noopener'>http://hl7.org/fhir/us/core/OperationDefinition-docref.html</a> for more details."
5169+
externalDocs:
5170+
description: 'Detailed documentation on this operation'
5171+
url: 'https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'
5172+
parameters:
5173+
-
5174+
name: patient
5175+
in: query
5176+
description: 'The uuid for the patient.'
5177+
required: true
5178+
schema:
5179+
type: string
5180+
-
5181+
name: start
5182+
in: query
5183+
description: 'The datetime refers to care dates not record currency dates. All records relating to care provided in a certain date range. If no start date is provided then all documents prior to the end date are in scope. If no start and end date are provided, the most recent or current document is in scope.'
5184+
required: false
5185+
schema:
5186+
type: string
5187+
-
5188+
name: end
5189+
in: query
5190+
description: 'The datetime refers to care dates not record currency dates. All records relating to care provided in a certain date range. If no end date is provided then all documents subsequent to the start date are in scope. If no start and end date are provided, the most recent or current document is in scope.'
5191+
required: false
5192+
schema:
5193+
type: string
5194+
-
5195+
name: type
5196+
in: query
5197+
description: "The type refers to the document type. This is a LOINC code from the valueset of <a href='http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html' target='_blank' rel='noopener'>http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html</a>. The server currently only supports the LOINC code of 34133-9 (Summary of episode node)."
5198+
required: false
5199+
schema:
5200+
type: string
5201+
responses:
5202+
200:
5203+
description: 'A search bundle of DocumentReferences is returned'
5204+
400:
5205+
$ref: '#/components/responses/badrequest'
5206+
401:
5207+
$ref: '#/components/responses/unauthorized'
5208+
security:
5209+
-
5210+
openemr_auth: { }
51645211
'/fhir/DocumentReference/{uuid}':
51655212
get:
51665213
tags:
@@ -8897,41 +8944,7 @@ components:
88978944
required: false
88988945
schema:
88998946
type: string
8900-
end:
8901-
name: end
8902-
in: query
8903-
description: 'The datetime refers to care dates not record currency dates. All records relating to care provided in a certain date range. If no end date is provided then all documents subsequent to the start date are in scope. If no start and end date are provided, the most recent or current document is in scope.'
8904-
required: false
8905-
schema:
8906-
type: string
8907-
patient:
8908-
name: patient
8909-
in: query
8910-
description: 'The uuid for the patient.'
8911-
required: true
8912-
schema:
8913-
type: string
8914-
start:
8915-
name: start
8916-
in: query
8917-
description: 'The datetime refers to care dates not record currency dates. All records relating to care provided in a certain date range. If no start date is provided then all documents prior to the end date are in scope. If no start and end date are provided, the most recent or current document is in scope.'
8918-
required: false
8919-
schema:
8920-
type: string
8921-
type:
8922-
name: type
8923-
in: query
8924-
description: "The type refers to the document type. This is a LOINC code from the valueset of <a href='http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html' target='_blank' rel='noopener'>http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html</a>. The server currently only supports the LOINC code of 34133-9 (Summary of episode node)."
8925-
required: false
8926-
schema:
8927-
type: string
89288947
responses:
8929-
200:
8930-
description: 'A search bundle of DocumentReferences is returned'
8931-
400:
8932-
$ref: '#/components/responses/badrequest'
8933-
401:
8934-
$ref: '#/components/responses/unauthorized'
89358948
badrequest:
89368949
description: 'Bad Request'
89378950
content:
@@ -10021,6 +10034,3 @@ tags:
1002110034
-
1002210035
name: standard-patient
1002310036
description: 'Standard Patient Portal OpenEMR API'
10024-
externalDocs:
10025-
description: 'Detailed documentation on this operation'
10026-
url: 'https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'

0 commit comments

Comments
 (0)