# generated: '2026-08-28' # method: derived # source: https://epicproxy.et0948.epichosted.com/FhirProxy/api/FHIR/R4/metadata (HTTP 200, application/fhir+json, fetched 2026-08-28) openapi: 3.1.0 info: title: Select Medical FHIR R4 API version: 4.0.1 summary: HL7 FHIR R4 patient-access API operated by Select Medical on its Epic platform. description: Machine-readable description of the Select Medical FHIR R4 server, DERIVED mechanically from the server's own CapabilityStatement at https://epicproxy.et0948.epichosted.com/FhirProxy/api/FHIR/R4/metadata (fetched 2026-08-28, HTTP 200, application/fhir+json). The CapabilityStatement self-identifies as "Select Medical FHIR Server" and is the endpoint registered to "Select Medical" in Epic's public endpoint directory at https://open.epic.com/Endpoints/R4. Every path, method and query parameter here corresponds to an interaction or searchParam the server declares; nothing has been added. Access is SMART-on-FHIR OAuth 2.0 and requires app registration and patient authorization — this document describes the contract, not open access. contact: name: Select Medical url: https://www.selectmedical.com/ license: name: HL7 FHIR R4 (4.0.1) url: https://hl7.org/fhir/R4/ externalDocs: description: HL7 FHIR R4 RESTful API specification url: https://hl7.org/fhir/R4/http.html servers: - url: https://epicproxy.et0948.epichosted.com/FhirProxy/api/FHIR/R4 description: Select Medical FHIR R4 production server (Epic FhirProxy, community et0948) security: - smartOnFhir: [] tags: - name: Account description: FHIR R4 Account resource as declared by the Select Medical FHIR server CapabilityStatement. - name: AdverseEvent description: FHIR R4 AdverseEvent resource as declared by the Select Medical FHIR server CapabilityStatement. - name: AllergyIntolerance description: 'FHIR R4 AllergyIntolerance resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-allergyintolerance|6.1.0.' - name: Appointment description: FHIR R4 Appointment resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Binary description: FHIR R4 Binary resource as declared by the Select Medical FHIR server CapabilityStatement. - name: BodyStructure description: FHIR R4 BodyStructure resource as declared by the Select Medical FHIR server CapabilityStatement. - name: CarePlan description: 'FHIR R4 CarePlan resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-careplan|6.1.0.' - name: CareTeam description: 'FHIR R4 CareTeam resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-careteam|6.1.0.' - name: Claim description: FHIR R4 Claim resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Communication description: FHIR R4 Communication resource as declared by the Select Medical FHIR server CapabilityStatement. - name: ConceptMap description: FHIR R4 ConceptMap resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Condition description: 'FHIR R4 Condition resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-condition-encounter-diagnosis|6.1.0, us-core-condition-problems-health-concerns|6.1.0.' - name: Consent description: FHIR R4 Consent resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Contract description: FHIR R4 Contract resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Coverage description: 'FHIR R4 Coverage resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-coverage|6.1.0.' - name: Device description: 'FHIR R4 Device resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-implantable-device|6.1.0.' - name: DeviceRequest description: FHIR R4 DeviceRequest resource as declared by the Select Medical FHIR server CapabilityStatement. - name: DeviceUseStatement description: FHIR R4 DeviceUseStatement resource as declared by the Select Medical FHIR server CapabilityStatement. - name: DiagnosticReport description: 'FHIR R4 DiagnosticReport resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-diagnosticreport-lab|6.1.0, us-core-diagnosticreport-note|6.1.0.' - name: DocumentReference description: 'FHIR R4 DocumentReference resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-documentreference|6.1.0.' - name: Encounter description: 'FHIR R4 Encounter resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-encounter|6.1.0.' - name: Endpoint description: FHIR R4 Endpoint resource as declared by the Select Medical FHIR server CapabilityStatement. - name: EpisodeOfCare description: FHIR R4 EpisodeOfCare resource as declared by the Select Medical FHIR server CapabilityStatement. - name: ExplanationOfBenefit description: FHIR R4 ExplanationOfBenefit resource as declared by the Select Medical FHIR server CapabilityStatement. - name: FamilyMemberHistory description: FHIR R4 FamilyMemberHistory resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Flag description: FHIR R4 Flag resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Goal description: 'FHIR R4 Goal resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-goal|6.1.0.' - name: Group description: FHIR R4 Group resource as declared by the Select Medical FHIR server CapabilityStatement. - name: ImagingStudy description: FHIR R4 ImagingStudy resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Immunization description: 'FHIR R4 Immunization resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-immunization|6.1.0.' - name: ImmunizationRecommendation description: FHIR R4 ImmunizationRecommendation resource as declared by the Select Medical FHIR server CapabilityStatement. - name: List description: FHIR R4 List resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Location description: FHIR R4 Location resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Measure description: FHIR R4 Measure resource as declared by the Select Medical FHIR server CapabilityStatement. - name: MeasureReport description: FHIR R4 MeasureReport resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Media description: FHIR R4 Media resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Medication description: 'FHIR R4 Medication resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-medication|6.1.0.' - name: MedicationAdministration description: FHIR R4 MedicationAdministration resource as declared by the Select Medical FHIR server CapabilityStatement. - name: MedicationDispense description: 'FHIR R4 MedicationDispense resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-medicationdispense|6.1.0.' - name: MedicationRequest description: 'FHIR R4 MedicationRequest resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-medicationrequest|6.1.0.' - name: NutritionOrder description: FHIR R4 NutritionOrder resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Observation description: 'FHIR R4 Observation resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: head-occipital-frontal-circumference-percentile|6.1.0, pediatric-bmi-for-age|6.1.0, pediatric-weight-for-height|6.1.0, us-core-blood-pressure|6.1.0, us-core-bmi|6.1.0, us-core-body-height|6.1.0, us-core-body-temperature|6.1.0, us-core-body-weight|6.1.0, us-core-head-circumference|6.1.0, us-core-heart-rate|6.1.0, us-core-observation-clinical-result|6.1.0, us-core-observation-lab|6.1.0, us-core-observation-occupation|6.1.0, us-core-observation-pregnancyintent|6.1.0, us-core-observation-pregnancystatus|6.1.0, us-core-observation-screening-assessment|6.1.0, us-core-observation-sexual-orientation|6.1.0, us-core-pulse-oximetry|6.1.0, us-core-respiratory-rate|6.1.0, us-core-simple-observation|6.1.0, us-core-smokingstatus|6.1.0, us-core-vital-signs|6.1.0.' - name: Organization description: 'FHIR R4 Organization resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-organization|6.1.0.' - name: Patient description: 'FHIR R4 Patient resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-patient|6.1.0.' - name: Practitioner description: 'FHIR R4 Practitioner resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-practitioner|6.1.0.' - name: PractitionerRole description: 'FHIR R4 PractitionerRole resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-practitionerrole|6.1.0.' - name: Procedure description: 'FHIR R4 Procedure resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-procedure|6.1.0.' - name: Provenance description: 'FHIR R4 Provenance resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-provenance|6.1.0.' - name: Questionnaire description: FHIR R4 Questionnaire resource as declared by the Select Medical FHIR server CapabilityStatement. - name: QuestionnaireResponse description: FHIR R4 QuestionnaireResponse resource as declared by the Select Medical FHIR server CapabilityStatement. - name: RelatedPerson description: 'FHIR R4 RelatedPerson resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-relatedperson|6.1.0.' - name: RequestGroup description: FHIR R4 RequestGroup resource as declared by the Select Medical FHIR server CapabilityStatement. - name: ResearchStudy description: FHIR R4 ResearchStudy resource as declared by the Select Medical FHIR server CapabilityStatement. - name: ResearchSubject description: FHIR R4 ResearchSubject resource as declared by the Select Medical FHIR server CapabilityStatement. - name: ServiceRequest description: 'FHIR R4 ServiceRequest resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-servicerequest|6.1.0.' - name: Specimen description: 'FHIR R4 Specimen resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-specimen|6.1.0.' - name: Substance description: FHIR R4 Substance resource as declared by the Select Medical FHIR server CapabilityStatement. - name: Task description: FHIR R4 Task resource as declared by the Select Medical FHIR server CapabilityStatement. - name: ValueSet description: FHIR R4 ValueSet resource as declared by the Select Medical FHIR server CapabilityStatement. paths: /Account: get: operationId: searchAccount summary: Search Account resources description: Search for Account resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Account parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Account resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Account/{id}: get: operationId: readAccount summary: Read a Account resource by id tags: - Account description: Retrieve a single Account resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Account resource. schema: type: string responses: '200': description: The requested Account resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /AdverseEvent: get: operationId: searchAdverseEvent summary: Search AdverseEvent resources description: Search for AdverseEvent resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - AdverseEvent parameters: - name: research-subject in: query description: Search for AdverseEvent resources for a specified research study participant. required: false schema: type: string - name: seriousness in: query description: Refine a search for AdverseEvent resources by seriousness of the event. Serious and Non-serious are the only supported values. required: false schema: type: string - name: study in: query description: Search for AdverseEvent resources for a specified study ID. required: false schema: type: string - name: subject in: query description: Search for AdverseEvent resources for a specified patient ID. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: actuality in: query description: FHIR search parameter 'actuality' declared for AdverseEvent. required: false schema: type: string - name: category in: query description: FHIR search parameter 'category' declared for AdverseEvent. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for AdverseEvent. required: false schema: type: string - name: event in: query description: FHIR search parameter 'event' declared for AdverseEvent. required: false schema: type: string - name: location in: query description: FHIR search parameter 'location' declared for AdverseEvent. required: false schema: type: string - name: recorder in: query description: FHIR search parameter 'recorder' declared for AdverseEvent. required: false schema: type: string - name: resultingcondition in: query description: FHIR search parameter 'resultingcondition' declared for AdverseEvent. required: false schema: type: string - name: severity in: query description: FHIR search parameter 'severity' declared for AdverseEvent. required: false schema: type: string - name: substance in: query description: FHIR search parameter 'substance' declared for AdverseEvent. required: false schema: type: string responses: '200': description: A Bundle of matching AdverseEvent resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /AdverseEvent/{id}: get: operationId: readAdverseEvent summary: Read a AdverseEvent resource by id tags: - AdverseEvent description: Retrieve a single AdverseEvent resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the AdverseEvent resource. schema: type: string responses: '200': description: The requested AdverseEvent resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /AllergyIntolerance: get: operationId: searchAllergyIntolerance summary: Search AllergyIntolerance resources description: Search for AllergyIntolerance resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - AllergyIntolerance parameters: - name: clinical-status in: query description: Refine a search for AllergyIntolerance resources by clinicalStatus. Active is the only supported clinical status to search by. required: false schema: type: string - name: patient in: query description: Search for AllergyIntolerance resources for a specified patient ID. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: asserter in: query description: FHIR search parameter 'asserter' declared for AllergyIntolerance. required: false schema: type: string - name: category in: query description: FHIR search parameter 'category' declared for AllergyIntolerance. required: false schema: type: string - name: code in: query description: FHIR search parameter 'code' declared for AllergyIntolerance. required: false schema: type: string - name: criticality in: query description: FHIR search parameter 'criticality' declared for AllergyIntolerance. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for AllergyIntolerance. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for AllergyIntolerance. required: false schema: type: string - name: last-date in: query description: FHIR search parameter 'last-date' declared for AllergyIntolerance. required: false schema: type: string - name: manifestation in: query description: FHIR search parameter 'manifestation' declared for AllergyIntolerance. required: false schema: type: string - name: onset in: query description: FHIR search parameter 'onset' declared for AllergyIntolerance. required: false schema: type: string - name: recorder in: query description: FHIR search parameter 'recorder' declared for AllergyIntolerance. required: false schema: type: string - name: route in: query description: FHIR search parameter 'route' declared for AllergyIntolerance. required: false schema: type: string - name: severity in: query description: FHIR search parameter 'severity' declared for AllergyIntolerance. required: false schema: type: string - name: type in: query description: FHIR search parameter 'type' declared for AllergyIntolerance. required: false schema: type: string - name: verification-status in: query description: FHIR search parameter 'verification-status' declared for AllergyIntolerance. required: false schema: type: string responses: '200': description: A Bundle of matching AllergyIntolerance resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createAllergyIntolerance summary: Create a AllergyIntolerance resource tags: - AllergyIntolerance description: Create a new AllergyIntolerance resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The AllergyIntolerance resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /AllergyIntolerance/{id}: get: operationId: readAllergyIntolerance summary: Read a AllergyIntolerance resource by id tags: - AllergyIntolerance description: Retrieve a single AllergyIntolerance resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the AllergyIntolerance resource. schema: type: string responses: '200': description: The requested AllergyIntolerance resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Appointment: get: operationId: searchAppointment summary: Search Appointment resources description: Search for Appointment resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Appointment parameters: - name: date in: query description: FHIR search parameter 'date' declared for Appointment. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Appointment. required: false schema: type: string - name: onlyscannable in: query description: Refine a search for Appointment resources to scannable appointments only. By default, all Appointments are returned. Use a value of "true" to only return scannable appointments. Can only be used when the application is launched from Hyperspace. required: false schema: type: string - name: patient in: query description: Search for Appointment resources for a specified patient ID. required: false schema: type: string - name: service-category in: query description: Search on the type of appointment. Enter 'surgery' for scheduled surgery appointments, and 'appointment' for all other types of appointments. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for Appointment. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: actor in: query description: FHIR search parameter 'actor' declared for Appointment. required: false schema: type: string - name: appointment-type in: query description: FHIR search parameter 'appointment-type' declared for Appointment. required: false schema: type: string - name: based-on in: query description: FHIR search parameter 'based-on' declared for Appointment. required: false schema: type: string - name: location in: query description: FHIR search parameter 'location' declared for Appointment. required: false schema: type: string - name: part-status in: query description: FHIR search parameter 'part-status' declared for Appointment. required: false schema: type: string - name: practitioner in: query description: FHIR search parameter 'practitioner' declared for Appointment. required: false schema: type: string - name: reason-code in: query description: FHIR search parameter 'reason-code' declared for Appointment. required: false schema: type: string - name: reason-reference in: query description: FHIR search parameter 'reason-reference' declared for Appointment. required: false schema: type: string - name: service-type in: query description: FHIR search parameter 'service-type' declared for Appointment. required: false schema: type: string - name: slot in: query description: FHIR search parameter 'slot' declared for Appointment. required: false schema: type: string - name: specialty in: query description: FHIR search parameter 'specialty' declared for Appointment. required: false schema: type: string - name: supporting-info in: query description: FHIR search parameter 'supporting-info' declared for Appointment. required: false schema: type: string responses: '200': description: A Bundle of matching Appointment resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Appointment/{id}: get: operationId: readAppointment summary: Read a Appointment resource by id tags: - Appointment description: Retrieve a single Appointment resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Appointment resource. schema: type: string responses: '200': description: The requested Appointment resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Binary: get: operationId: searchBinary summary: Search Binary resources description: Search for Binary resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Binary parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Binary resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Binary/{id}: get: operationId: readBinary summary: Read a Binary resource by id tags: - Binary description: Retrieve a single Binary resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Binary resource. schema: type: string responses: '200': description: The requested Binary resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /BodyStructure: get: operationId: searchBodyStructure summary: Search BodyStructure resources description: Search for BodyStructure resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - BodyStructure parameters: - name: identifier in: query description: Refine a search for BodyStructure resources by identifier. Enter using the structure "[system]|[search string]". required: false schema: type: string - name: location in: query description: Refine a search for BodyStructure resources by location. required: false schema: type: string - name: morphology in: query description: Refine a search for BodyStructure resources by morphology. required: false schema: type: string - name: patient in: query description: Search for BodyStructure resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: subject in: query description: Search for BodyStructure resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching BodyStructure resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createBodyStructure summary: Create a BodyStructure resource tags: - BodyStructure description: Create a new BodyStructure resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The BodyStructure resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /BodyStructure/{id}: get: operationId: readBodyStructure summary: Read a BodyStructure resource by id tags: - BodyStructure description: Retrieve a single BodyStructure resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the BodyStructure resource. schema: type: string responses: '200': description: The requested BodyStructure resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: operationId: updateBodyStructure summary: Update a BodyStructure resource tags: - BodyStructure description: Update an existing BodyStructure resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the BodyStructure resource. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: The BodyStructure resource was updated. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /CarePlan: get: operationId: searchCarePlan summary: Search CarePlan resources description: Search for CarePlan resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - CarePlan parameters: - name: activity-date in: query description: FHIR search parameter 'activity-date' declared for CarePlan. required: false schema: type: string - name: category in: query description: Search for CarePlans of the given type. This is a required search parameter. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for CarePlan. required: false schema: type: string - name: part-of in: query description: FHIR search parameter 'part-of' declared for CarePlan. required: false schema: type: string - name: patient in: query description: Search for CarePlan resources using a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for CarePlan. required: false schema: type: string - name: subject in: query description: Search for CarePlan resources using a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: activity-code in: query description: FHIR search parameter 'activity-code' declared for CarePlan. required: false schema: type: string - name: activity-reference in: query description: FHIR search parameter 'activity-reference' declared for CarePlan. required: false schema: type: string - name: based-on in: query description: FHIR search parameter 'based-on' declared for CarePlan. required: false schema: type: string - name: care-team in: query description: FHIR search parameter 'care-team' declared for CarePlan. required: false schema: type: string - name: condition in: query description: FHIR search parameter 'condition' declared for CarePlan. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for CarePlan. required: false schema: type: string - name: goal in: query description: FHIR search parameter 'goal' declared for CarePlan. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for CarePlan. required: false schema: type: string - name: instantiates-canonical in: query description: FHIR search parameter 'instantiates-canonical' declared for CarePlan. required: false schema: type: string - name: intent in: query description: FHIR search parameter 'intent' declared for CarePlan. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for CarePlan. required: false schema: type: string - name: replaces in: query description: FHIR search parameter 'replaces' declared for CarePlan. required: false schema: type: string responses: '200': description: A Bundle of matching CarePlan resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /CarePlan/{id}: get: operationId: readCarePlan summary: Read a CarePlan resource by id tags: - CarePlan description: Retrieve a single CarePlan resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the CarePlan resource. schema: type: string responses: '200': description: The requested CarePlan resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /CareTeam: get: operationId: searchCareTeam summary: Search CareTeam resources description: Search for CareTeam resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - CareTeam parameters: - name: patient in: query description: Search for CareTeam resources using a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: status in: query description: Refine a search based on the CareTeam's status. Currently only active is supported. required: false schema: type: string - name: subject in: query description: Search for CareTeam resources using a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: category in: query description: FHIR search parameter 'category' declared for CareTeam. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for CareTeam. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for CareTeam. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for CareTeam. required: false schema: type: string - name: participant in: query description: FHIR search parameter 'participant' declared for CareTeam. required: false schema: type: string responses: '200': description: A Bundle of matching CareTeam resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /CareTeam/{id}: get: operationId: readCareTeam summary: Read a CareTeam resource by id tags: - CareTeam description: Retrieve a single CareTeam resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the CareTeam resource. schema: type: string responses: '200': description: The requested CareTeam resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Claim: get: operationId: searchClaim summary: Search Claim resources description: Search for Claim resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Claim parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Claim resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Claim/{id}: get: operationId: readClaim summary: Read a Claim resource by id tags: - Claim description: Retrieve a single Claim resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Claim resource. schema: type: string responses: '200': description: The requested Claim resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Communication: get: operationId: searchCommunication summary: Search Communication resources description: Search for Communication resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Communication parameters: - name: based-on in: query description: FHIR search parameter 'based-on' declared for Communication. required: false schema: type: string - name: category in: query description: Refine a search to include only Communication resources with the given categories. required: false schema: type: string - name: encounter in: query description: Refine a search to include Communication resources from only the encounters provided. required: false schema: type: string - name: part-of in: query description: FHIR search parameter 'part-of' declared for Communication. required: false schema: type: string - name: patient in: query description: Search for Communication resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: subject in: query description: Search for Communication resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Communication. required: false schema: type: string - name: instantiates-canonical in: query description: FHIR search parameter 'instantiates-canonical' declared for Communication. required: false schema: type: string - name: medium in: query description: FHIR search parameter 'medium' declared for Communication. required: false schema: type: string - name: received in: query description: FHIR search parameter 'received' declared for Communication. required: false schema: type: string - name: recipient in: query description: FHIR search parameter 'recipient' declared for Communication. required: false schema: type: string - name: sender in: query description: FHIR search parameter 'sender' declared for Communication. required: false schema: type: string - name: sent in: query description: FHIR search parameter 'sent' declared for Communication. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for Communication. required: false schema: type: string responses: '200': description: A Bundle of matching Communication resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createCommunication summary: Create a Communication resource tags: - Communication description: Create a new Communication resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The Communication resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /Communication/{id}: get: operationId: readCommunication summary: Read a Communication resource by id tags: - Communication description: Retrieve a single Communication resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Communication resource. schema: type: string responses: '200': description: The requested Communication resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ConceptMap: post: operationId: createConceptMap summary: Create a ConceptMap resource tags: - ConceptMap description: Create a new ConceptMap resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The ConceptMap resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /ConceptMap/{id}: get: operationId: readConceptMap summary: Read a ConceptMap resource by id tags: - ConceptMap description: Retrieve a single ConceptMap resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the ConceptMap resource. schema: type: string responses: '200': description: The requested ConceptMap resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Condition: get: operationId: searchCondition summary: Search Condition resources description: Search for Condition resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Condition parameters: - name: abatement-date in: query description: Search for Conditions with a specified abatement date. required: false schema: type: string - name: category in: query description: Search for Condition resources by category. required: false schema: type: string - name: clinical-status in: query description: Refine a search for Condition resources by clinicalStatus. Only clinical statuses of 'inactive', 'resolved' and 'active' are supported for health concerns and problem list items. Only clinical statuses of 'inactive' and 'active' are supported for infections. required: false schema: type: string - name: code in: query description: Search for Conditions with a specified code. required: false schema: type: string - name: encounter in: query description: Search for Condition resources for specific encounters. required: false schema: type: string - name: onset-date in: query description: Search for Conditions with a specified onset date. required: false schema: type: string - name: patient in: query description: Search for Condition resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: recorded-date in: query description: Search for Conditions with a specified recorded date. required: false schema: type: string - name: subject in: query description: Search for Condition resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: abatement-string in: query description: FHIR search parameter 'abatement-string' declared for Condition. required: false schema: type: string - name: asserter in: query description: FHIR search parameter 'asserter' declared for Condition. required: false schema: type: string - name: body-site in: query description: FHIR search parameter 'body-site' declared for Condition. required: false schema: type: string - name: evidence in: query description: FHIR search parameter 'evidence' declared for Condition. required: false schema: type: string - name: evidence-detail in: query description: FHIR search parameter 'evidence-detail' declared for Condition. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Condition. required: false schema: type: string - name: onset-info in: query description: FHIR search parameter 'onset-info' declared for Condition. required: false schema: type: string - name: severity in: query description: FHIR search parameter 'severity' declared for Condition. required: false schema: type: string - name: stage in: query description: FHIR search parameter 'stage' declared for Condition. required: false schema: type: string - name: verification-status in: query description: FHIR search parameter 'verification-status' declared for Condition. required: false schema: type: string responses: '200': description: A Bundle of matching Condition resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createCondition summary: Create a Condition resource tags: - Condition description: Create a new Condition resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The Condition resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /Condition/{id}: get: operationId: readCondition summary: Read a Condition resource by id tags: - Condition description: Retrieve a single Condition resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Condition resource. schema: type: string responses: '200': description: The requested Condition resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Consent: get: operationId: searchConsent summary: Search Consent resources description: Search for Consent resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Consent parameters: - name: category in: query description: Search for Consent resources by category. required: false schema: type: string - name: patient in: query description: Search for Consent resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: status in: query description: Search for Consent resources by status. required: false schema: type: string - name: subject in: query description: Search for Consent resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: action in: query description: FHIR search parameter 'action' declared for Consent. required: false schema: type: string - name: actor in: query description: FHIR search parameter 'actor' declared for Consent. required: false schema: type: string - name: consentor in: query description: FHIR search parameter 'consentor' declared for Consent. required: false schema: type: string - name: data in: query description: FHIR search parameter 'data' declared for Consent. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for Consent. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Consent. required: false schema: type: string - name: organization in: query description: FHIR search parameter 'organization' declared for Consent. required: false schema: type: string - name: period in: query description: FHIR search parameter 'period' declared for Consent. required: false schema: type: string - name: purpose in: query description: FHIR search parameter 'purpose' declared for Consent. required: false schema: type: string - name: scope in: query description: FHIR search parameter 'scope' declared for Consent. required: false schema: type: string - name: security-label in: query description: FHIR search parameter 'security-label' declared for Consent. required: false schema: type: string - name: source-reference in: query description: FHIR search parameter 'source-reference' declared for Consent. required: false schema: type: string responses: '200': description: A Bundle of matching Consent resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Consent/{id}: get: operationId: readConsent summary: Read a Consent resource by id tags: - Consent description: Retrieve a single Consent resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Consent resource. schema: type: string responses: '200': description: The requested Consent resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Contract: get: operationId: searchContract summary: Search Contract resources description: Search for Contract resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Contract parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Contract resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Contract/{id}: get: operationId: readContract summary: Read a Contract resource by id tags: - Contract description: Retrieve a single Contract resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Contract resource. schema: type: string responses: '200': description: The requested Contract resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Coverage: get: operationId: searchCoverage summary: Search Coverage resources description: Search for Coverage resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Coverage parameters: - name: beneficiary in: query description: Search for Coverage resource for a specific patient ID. You can use "patient" or "beneficiary" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: patient in: query description: Search for Coverage resource for a specific patient ID. You can use "patient" or "beneficiary" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: class-type in: query description: FHIR search parameter 'class-type' declared for Coverage. required: false schema: type: string - name: class-value in: query description: FHIR search parameter 'class-value' declared for Coverage. required: false schema: type: string - name: dependent in: query description: FHIR search parameter 'dependent' declared for Coverage. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Coverage. required: false schema: type: string - name: payor in: query description: FHIR search parameter 'payor' declared for Coverage. required: false schema: type: string - name: policy-holder in: query description: FHIR search parameter 'policy-holder' declared for Coverage. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for Coverage. required: false schema: type: string - name: subscriber in: query description: FHIR search parameter 'subscriber' declared for Coverage. required: false schema: type: string - name: type in: query description: FHIR search parameter 'type' declared for Coverage. required: false schema: type: string responses: '200': description: A Bundle of matching Coverage resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Coverage/{id}: get: operationId: readCoverage summary: Read a Coverage resource by id tags: - Coverage description: Retrieve a single Coverage resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Coverage resource. schema: type: string responses: '200': description: The requested Coverage resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Device: get: operationId: searchDevice summary: Search Device resources description: Search for Device resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Device parameters: - name: device-name in: query description: A string that will match the Device.deviceName.name field. Not case sensitive. required: false schema: type: string - name: manufacturer in: query description: Manufacturer of the device. required: false schema: type: string - name: model in: query description: Model number of the device. required: false schema: type: string - name: patient in: query description: The patient in whom this device is implanted. This is a required parameter. required: false schema: type: string - name: udi-carrier in: query description: The UDI barcode string - matches static UDI. required: false schema: type: string - name: udi-di in: query description: The UDI device identifier (DI). required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Device. required: false schema: type: string - name: location in: query description: FHIR search parameter 'location' declared for Device. required: false schema: type: string - name: organization in: query description: FHIR search parameter 'organization' declared for Device. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for Device. required: false schema: type: string - name: type in: query description: FHIR search parameter 'type' declared for Device. required: false schema: type: string responses: '200': description: A Bundle of matching Device resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Device/{id}: get: operationId: readDevice summary: Read a Device resource by id tags: - Device description: Retrieve a single Device resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Device resource. schema: type: string responses: '200': description: The requested Device resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /DeviceRequest: get: operationId: searchDeviceRequest summary: Search DeviceRequest resources description: Search for DeviceRequest resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - DeviceRequest parameters: - name: patient in: query description: Search for DeviceRequest resource for a specified patient ID. required: false schema: type: string - name: status in: query description: Search for a DeviceRequest based on a device request status required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: authored-on in: query description: FHIR search parameter 'authored-on' declared for DeviceRequest. required: false schema: type: string - name: based-on in: query description: FHIR search parameter 'based-on' declared for DeviceRequest. required: false schema: type: string - name: code in: query description: FHIR search parameter 'code' declared for DeviceRequest. required: false schema: type: string - name: device in: query description: FHIR search parameter 'device' declared for DeviceRequest. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for DeviceRequest. required: false schema: type: string - name: event-date in: query description: FHIR search parameter 'event-date' declared for DeviceRequest. required: false schema: type: string - name: group-identifier in: query description: FHIR search parameter 'group-identifier' declared for DeviceRequest. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for DeviceRequest. required: false schema: type: string - name: instantiates-canonical in: query description: FHIR search parameter 'instantiates-canonical' declared for DeviceRequest. required: false schema: type: string - name: insurance in: query description: FHIR search parameter 'insurance' declared for DeviceRequest. required: false schema: type: string - name: intent in: query description: FHIR search parameter 'intent' declared for DeviceRequest. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for DeviceRequest. required: false schema: type: string - name: prior-request in: query description: FHIR search parameter 'prior-request' declared for DeviceRequest. required: false schema: type: string - name: requester in: query description: FHIR search parameter 'requester' declared for DeviceRequest. required: false schema: type: string - name: subject in: query description: FHIR search parameter 'subject' declared for DeviceRequest. required: false schema: type: string responses: '200': description: A Bundle of matching DeviceRequest resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /DeviceRequest/{id}: get: operationId: readDeviceRequest summary: Read a DeviceRequest resource by id tags: - DeviceRequest description: Retrieve a single DeviceRequest resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the DeviceRequest resource. schema: type: string responses: '200': description: The requested DeviceRequest resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /DeviceUseStatement: get: operationId: searchDeviceUseStatement summary: Search DeviceUseStatement resources description: Search for DeviceUseStatement resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - DeviceUseStatement parameters: - name: patient in: query description: Search for DeviceUseStatement resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: subject in: query description: Search for DeviceUseStatement resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: device in: query description: FHIR search parameter 'device' declared for DeviceUseStatement. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for DeviceUseStatement. required: false schema: type: string responses: '200': description: A Bundle of matching DeviceUseStatement resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /DeviceUseStatement/{id}: get: operationId: readDeviceUseStatement summary: Read a DeviceUseStatement resource by id tags: - DeviceUseStatement description: Retrieve a single DeviceUseStatement resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the DeviceUseStatement resource. schema: type: string responses: '200': description: The requested DeviceUseStatement resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /DiagnosticReport: get: operationId: searchDiagnosticReport summary: Search DiagnosticReport resources description: Search for DiagnosticReport resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - DiagnosticReport parameters: - name: category in: query description: Refine a search for DiagnosticReport resources by category. required: false schema: type: string - name: code in: query description: Refine a search for DiagnosticReport resources by code. required: false schema: type: string - name: date in: query description: Refine a search for DiagnosticReport resources by specifying a date or date range that a DiagnosticReport was resulted or recorded. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included. required: false schema: type: string - name: identifier in: query description: Refine search by specifying an identifier, such as the internal order ID or the accession number. required: false schema: type: string - name: patient in: query description: Search for DiagnosticReport resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: subject in: query description: Search for DiagnosticReport resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: based-on in: query description: FHIR search parameter 'based-on' declared for DiagnosticReport. required: false schema: type: string - name: conclusion in: query description: FHIR search parameter 'conclusion' declared for DiagnosticReport. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for DiagnosticReport. required: false schema: type: string - name: issued in: query description: FHIR search parameter 'issued' declared for DiagnosticReport. required: false schema: type: string - name: media in: query description: FHIR search parameter 'media' declared for DiagnosticReport. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for DiagnosticReport. required: false schema: type: string - name: result in: query description: FHIR search parameter 'result' declared for DiagnosticReport. required: false schema: type: string - name: results-interpreter in: query description: FHIR search parameter 'results-interpreter' declared for DiagnosticReport. required: false schema: type: string - name: specimen in: query description: FHIR search parameter 'specimen' declared for DiagnosticReport. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for DiagnosticReport. required: false schema: type: string responses: '200': description: A Bundle of matching DiagnosticReport resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /DiagnosticReport/{id}: get: operationId: readDiagnosticReport summary: Read a DiagnosticReport resource by id tags: - DiagnosticReport description: Retrieve a single DiagnosticReport resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the DiagnosticReport resource. schema: type: string responses: '200': description: The requested DiagnosticReport resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: operationId: updateDiagnosticReport summary: Update a DiagnosticReport resource tags: - DiagnosticReport description: Update an existing DiagnosticReport resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the DiagnosticReport resource. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: The DiagnosticReport resource was updated. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /DocumentReference: get: operationId: searchDocumentReference summary: Search DocumentReference resources description: Search for DocumentReference resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - DocumentReference parameters: - name: author in: query description: Further refine a search for a given set of DocumentReferences on a patient by specifying a Reference that corresponds to the author of the document. required: false schema: type: string - name: category in: query description: Refine a search for DocumentReference resources by category. required: false schema: type: string - name: date in: query description: Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]]) that corresponds to the document creation time. Local server time is assumed if time zone information is not included. required: false schema: type: string - name: docstatus in: query description: Further refine a search for a given set of DocumentReferences on a patient by specifying a docStatus. By default, all docStatuses are returned. required: false schema: type: string - name: encounter in: query description: Search for DocumentReference resources for a specific internal or external encounter required: false schema: type: string - name: patient in: query description: Search for DocumentReference resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: period in: query description: Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD]]) that corresponds to the time of the service that is being documented. required: false schema: type: string - name: status in: query description: Further refine a search for a given set of DocumentReferences on a patient by specifying a status of the document. required: false schema: type: string - name: subject in: query description: Search for DocumentReference resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: type in: query description: 'Further refine a search for a given set of DocumentReferences on a patient by specifying a type code to return only documents of that type. Use the format: type= to search all supported systems with that code or type=| to further refine the search to one code system. Not supported for questionnaire-response search.' required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: _lastupdated in: query description: Further refine a search by the date list in meta.lastupdated. required: false schema: type: string - name: authenticator in: query description: FHIR search parameter 'authenticator' declared for DocumentReference. required: false schema: type: string - name: contenttype in: query description: FHIR search parameter 'contenttype' declared for DocumentReference. required: false schema: type: string - name: custodian in: query description: FHIR search parameter 'custodian' declared for DocumentReference. required: false schema: type: string - name: description in: query description: FHIR search parameter 'description' declared for DocumentReference. required: false schema: type: string - name: event in: query description: FHIR search parameter 'event' declared for DocumentReference. required: false schema: type: string - name: facility in: query description: FHIR search parameter 'facility' declared for DocumentReference. required: false schema: type: string - name: format in: query description: FHIR search parameter 'format' declared for DocumentReference. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for DocumentReference. required: false schema: type: string - name: language in: query description: FHIR search parameter 'language' declared for DocumentReference. required: false schema: type: string - name: related in: query description: FHIR search parameter 'related' declared for DocumentReference. required: false schema: type: string - name: relatesto in: query description: FHIR search parameter 'relatesto' declared for DocumentReference. required: false schema: type: string - name: relation in: query description: FHIR search parameter 'relation' declared for DocumentReference. required: false schema: type: string - name: security-label in: query description: FHIR search parameter 'security-label' declared for DocumentReference. required: false schema: type: string - name: setting in: query description: FHIR search parameter 'setting' declared for DocumentReference. required: false schema: type: string responses: '200': description: A Bundle of matching DocumentReference resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createDocumentReference summary: Create a DocumentReference resource tags: - DocumentReference description: Create a new DocumentReference resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The DocumentReference resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /DocumentReference/{id}: get: operationId: readDocumentReference summary: Read a DocumentReference resource by id tags: - DocumentReference description: Retrieve a single DocumentReference resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the DocumentReference resource. schema: type: string responses: '200': description: The requested DocumentReference resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: operationId: updateDocumentReference summary: Update a DocumentReference resource tags: - DocumentReference description: Update an existing DocumentReference resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the DocumentReference resource. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: The DocumentReference resource was updated. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Encounter: get: operationId: searchEncounter summary: Search Encounter resources description: Search for Encounter resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Encounter parameters: - name: class in: query description: Refine a search for Encounter resources by class. By default, all classes are returned. required: false schema: type: string - name: date in: query description: Refine a search for Encounter resources by date. By default, all Encounters are returned. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]]). Local server time is assumed if time zone information is not included. required: false schema: type: string - name: identifier in: query description: Search for Encounter resources by encounter identifier in the format | required: false schema: type: string - name: onlyscannable in: query description: Refine a search for Encounter resources to scannable encounters only. By default, all Encounters are returned. Use a value of "true" to only return scannable encounters. Can only be used when the application is launched from Hyperspace. required: false schema: type: string - name: patient in: query description: Search for Encounter resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references. required: false schema: type: string - name: subject in: query description: Search for Encounter resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: account in: query description: FHIR search parameter 'account' declared for Encounter. required: false schema: type: string - name: appointment in: query description: FHIR search parameter 'appointment' declared for Encounter. required: false schema: type: string - name: based-on in: query description: FHIR search parameter 'based-on' declared for Encounter. required: false schema: type: string - name: diagnosis in: query description: FHIR search parameter 'diagnosis' declared for Encounter. required: false schema: type: string - name: episode-of-care in: query description: FHIR search parameter 'episode-of-care' declared for Encounter. required: false schema: type: string - name: location in: query description: FHIR search parameter 'location' declared for Encounter. required: false schema: type: string - name: location-period in: query description: FHIR search parameter 'location-period' declared for Encounter. required: false schema: type: string - name: part-of in: query description: FHIR search parameter 'part-of' declared for Encounter. required: false schema: type: string - name: participant in: query description: FHIR search parameter 'participant' declared for Encounter. required: false schema: type: string - name: participant-type in: query description: FHIR search parameter 'participant-type' declared for Encounter. required: false schema: type: string - name: practitioner in: query description: FHIR search parameter 'practitioner' declared for Encounter. required: false schema: type: string - name: reason-code in: query description: FHIR search parameter 'reason-code' declared for Encounter. required: false schema: type: string - name: reason-reference in: query description: FHIR search parameter 'reason-reference' declared for Encounter. required: false schema: type: string - name: service-provider in: query description: FHIR search parameter 'service-provider' declared for Encounter. required: false schema: type: string - name: special-arrangement in: query description: FHIR search parameter 'special-arrangement' declared for Encounter. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for Encounter. required: false schema: type: string - name: type in: query description: FHIR search parameter 'type' declared for Encounter. required: false schema: type: string responses: '200': description: A Bundle of matching Encounter resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Encounter/{id}: get: operationId: readEncounter summary: Read a Encounter resource by id tags: - Encounter description: Retrieve a single Encounter resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Encounter resource. schema: type: string responses: '200': description: The requested Encounter resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Endpoint: get: operationId: searchEndpoint summary: Search Endpoint resources description: Search for Endpoint resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Endpoint parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Endpoint resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Endpoint/{id}: get: operationId: readEndpoint summary: Read a Endpoint resource by id tags: - Endpoint description: Retrieve a single Endpoint resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Endpoint resource. schema: type: string responses: '200': description: The requested Endpoint resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /EpisodeOfCare: get: operationId: searchEpisodeOfCare summary: Search EpisodeOfCare resources description: Search for EpisodeOfCare resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - EpisodeOfCare parameters: - name: patient in: query description: Search for EpisodeOfCare resources for a specified patient ID. required: false schema: type: string - name: status in: query description: Refine a search for EpisodeOfCare resources by status. Active, finished, and cancelled are the only supported statuses. required: false schema: type: string - name: type in: query description: Refine a search for EpisodeOfCare resources by type. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: care-manager in: query description: FHIR search parameter 'care-manager' declared for EpisodeOfCare. required: false schema: type: string - name: condition in: query description: FHIR search parameter 'condition' declared for EpisodeOfCare. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for EpisodeOfCare. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for EpisodeOfCare. required: false schema: type: string - name: incoming-referral in: query description: FHIR search parameter 'incoming-referral' declared for EpisodeOfCare. required: false schema: type: string - name: organization in: query description: FHIR search parameter 'organization' declared for EpisodeOfCare. required: false schema: type: string responses: '200': description: A Bundle of matching EpisodeOfCare resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /EpisodeOfCare/{id}: get: operationId: readEpisodeOfCare summary: Read a EpisodeOfCare resource by id tags: - EpisodeOfCare description: Retrieve a single EpisodeOfCare resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the EpisodeOfCare resource. schema: type: string responses: '200': description: The requested EpisodeOfCare resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ExplanationOfBenefit: get: operationId: searchExplanationOfBenefit summary: Search ExplanationOfBenefit resources description: Search for ExplanationOfBenefit resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - ExplanationOfBenefit parameters: - name: created in: query description: Refine a search for ExplanationOfBenefit resources by creation date for the claim. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included. required: false schema: type: string - name: patient in: query description: Search for ExplanationOfBenefit resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: use in: query description: Refine a search for ExplanationOfBenefit by use. By default, the search returns all uses. Use of claim and preauthorization are supported. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: care-team in: query description: FHIR search parameter 'care-team' declared for ExplanationOfBenefit. required: false schema: type: string - name: claim in: query description: FHIR search parameter 'claim' declared for ExplanationOfBenefit. required: false schema: type: string - name: coverage in: query description: FHIR search parameter 'coverage' declared for ExplanationOfBenefit. required: false schema: type: string - name: detail-udi in: query description: FHIR search parameter 'detail-udi' declared for ExplanationOfBenefit. required: false schema: type: string - name: disposition in: query description: FHIR search parameter 'disposition' declared for ExplanationOfBenefit. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for ExplanationOfBenefit. required: false schema: type: string - name: enterer in: query description: FHIR search parameter 'enterer' declared for ExplanationOfBenefit. required: false schema: type: string - name: facility in: query description: FHIR search parameter 'facility' declared for ExplanationOfBenefit. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for ExplanationOfBenefit. required: false schema: type: string - name: item-udi in: query description: FHIR search parameter 'item-udi' declared for ExplanationOfBenefit. required: false schema: type: string - name: payee in: query description: FHIR search parameter 'payee' declared for ExplanationOfBenefit. required: false schema: type: string - name: procedure-udi in: query description: FHIR search parameter 'procedure-udi' declared for ExplanationOfBenefit. required: false schema: type: string - name: provider in: query description: FHIR search parameter 'provider' declared for ExplanationOfBenefit. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for ExplanationOfBenefit. required: false schema: type: string - name: subdetail-udi in: query description: FHIR search parameter 'subdetail-udi' declared for ExplanationOfBenefit. required: false schema: type: string responses: '200': description: A Bundle of matching ExplanationOfBenefit resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ExplanationOfBenefit/{id}: get: operationId: readExplanationOfBenefit summary: Read a ExplanationOfBenefit resource by id tags: - ExplanationOfBenefit description: Retrieve a single ExplanationOfBenefit resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the ExplanationOfBenefit resource. schema: type: string responses: '200': description: The requested ExplanationOfBenefit resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /FamilyMemberHistory: get: operationId: searchFamilyMemberHistory summary: Search FamilyMemberHistory resources description: Search for FamilyMemberHistory resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - FamilyMemberHistory parameters: - name: patient in: query description: 'Required: the patient whose family history you''d like to search.' required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: code in: query description: FHIR search parameter 'code' declared for FamilyMemberHistory. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for FamilyMemberHistory. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for FamilyMemberHistory. required: false schema: type: string - name: instantiates-canonical in: query description: FHIR search parameter 'instantiates-canonical' declared for FamilyMemberHistory. required: false schema: type: string - name: relationship in: query description: FHIR search parameter 'relationship' declared for FamilyMemberHistory. required: false schema: type: string - name: sex in: query description: FHIR search parameter 'sex' declared for FamilyMemberHistory. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for FamilyMemberHistory. required: false schema: type: string responses: '200': description: A Bundle of matching FamilyMemberHistory resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /FamilyMemberHistory/{id}: get: operationId: readFamilyMemberHistory summary: Read a FamilyMemberHistory resource by id tags: - FamilyMemberHistory description: Retrieve a single FamilyMemberHistory resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the FamilyMemberHistory resource. schema: type: string responses: '200': description: The requested FamilyMemberHistory resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Flag: get: operationId: searchFlag summary: Search Flag resources description: Search for Flag resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Flag parameters: - name: category in: query description: Refine a search for Flag resources by category. required: false schema: type: string - name: encounter in: query description: Refine a search for Flag resources by encounter. required: false schema: type: string - name: patient in: query description: Search for Flag resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: status in: query description: Refine a search for Flag resources by status. required: false schema: type: string - name: subject in: query description: Search for Flag resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: author in: query description: FHIR search parameter 'author' declared for Flag. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for Flag. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Flag. required: false schema: type: string responses: '200': description: A Bundle of matching Flag resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Flag/{id}: get: operationId: readFlag summary: Read a Flag resource by id tags: - Flag description: Retrieve a single Flag resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Flag resource. schema: type: string responses: '200': description: The requested Flag resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Goal: get: operationId: searchGoal summary: Search Goal resources description: Search for Goal resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Goal parameters: - name: category in: query description: Refines a search by Goal category. required: false schema: type: string - name: lifecycle-status in: query description: Refines a search based on Goal lifecycle status. required: false schema: type: string - name: patient in: query description: Search for Patient resources for a specific patient ID. You can use "patient" or "subject" equivalently but they can't be used at the same time for different references. required: false schema: type: string - name: start-date in: query description: Refines a search based on Goal start date. required: false schema: type: string - name: subject in: query description: Search for Patient resources for a specific patient ID. You can use "patient" or "subject" equivalently but they can't be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: achievement-status in: query description: FHIR search parameter 'achievement-status' declared for Goal. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Goal. required: false schema: type: string - name: target-date in: query description: FHIR search parameter 'target-date' declared for Goal. required: false schema: type: string responses: '200': description: A Bundle of matching Goal resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Goal/{id}: get: operationId: readGoal summary: Read a Goal resource by id tags: - Goal description: Retrieve a single Goal resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Goal resource. schema: type: string responses: '200': description: The requested Goal resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Group: get: operationId: searchGroup summary: Search Group resources description: Search for Group resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Group parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Group resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Group/{id}: get: operationId: readGroup summary: Read a Group resource by id tags: - Group description: Retrieve a single Group resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Group resource. schema: type: string responses: '200': description: The requested Group resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ImagingStudy: get: operationId: searchImagingStudy summary: Search ImagingStudy resources description: Search for ImagingStudy resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - ImagingStudy parameters: - name: identifier in: query description: Search for ImagingStudy resources by a study's identifier. You can use the identifier parameter as the only parameter in a search or in conjunction with other parameters. An ImagingStudy's identifier must be in the format | or |. required: false schema: type: string - name: patient in: query description: Search for ImagingStudy resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: subject in: query description: Search for ImagingStudy resources for a specified patient ID. You can use "patient" and "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: basedon in: query description: FHIR search parameter 'basedon' declared for ImagingStudy. required: false schema: type: string - name: bodysite in: query description: FHIR search parameter 'bodysite' declared for ImagingStudy. required: false schema: type: string - name: dicom-class in: query description: FHIR search parameter 'dicom-class' declared for ImagingStudy. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for ImagingStudy. required: false schema: type: string - name: endpoint in: query description: FHIR search parameter 'endpoint' declared for ImagingStudy. required: false schema: type: string - name: instance in: query description: FHIR search parameter 'instance' declared for ImagingStudy. required: false schema: type: string - name: interpreter in: query description: FHIR search parameter 'interpreter' declared for ImagingStudy. required: false schema: type: string - name: modality in: query description: FHIR search parameter 'modality' declared for ImagingStudy. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for ImagingStudy. required: false schema: type: string - name: reason in: query description: FHIR search parameter 'reason' declared for ImagingStudy. required: false schema: type: string - name: referrer in: query description: FHIR search parameter 'referrer' declared for ImagingStudy. required: false schema: type: string - name: series in: query description: FHIR search parameter 'series' declared for ImagingStudy. required: false schema: type: string - name: started in: query description: FHIR search parameter 'started' declared for ImagingStudy. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for ImagingStudy. required: false schema: type: string responses: '200': description: A Bundle of matching ImagingStudy resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ImagingStudy/{id}: get: operationId: readImagingStudy summary: Read a ImagingStudy resource by id tags: - ImagingStudy description: Retrieve a single ImagingStudy resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the ImagingStudy resource. schema: type: string responses: '200': description: The requested ImagingStudy resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Immunization: get: operationId: searchImmunization summary: Search Immunization resources description: Search for Immunization resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Immunization parameters: - name: date in: query description: Refine a search for Immunization resources by vaccine administration date. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included. required: false schema: type: string - name: patient in: query description: Search for Immunization resources for a specified patient ID. required: false schema: type: string - name: status in: query description: Refine a search for Immunization resources by status. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Immunization. required: false schema: type: string - name: location in: query description: FHIR search parameter 'location' declared for Immunization. required: false schema: type: string - name: lot-number in: query description: FHIR search parameter 'lot-number' declared for Immunization. required: false schema: type: string - name: manufacturer in: query description: FHIR search parameter 'manufacturer' declared for Immunization. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for Immunization. required: false schema: type: string - name: reaction in: query description: FHIR search parameter 'reaction' declared for Immunization. required: false schema: type: string - name: reaction-date in: query description: FHIR search parameter 'reaction-date' declared for Immunization. required: false schema: type: string - name: reason-code in: query description: FHIR search parameter 'reason-code' declared for Immunization. required: false schema: type: string - name: reason-reference in: query description: FHIR search parameter 'reason-reference' declared for Immunization. required: false schema: type: string - name: series in: query description: FHIR search parameter 'series' declared for Immunization. required: false schema: type: string - name: status-reason in: query description: FHIR search parameter 'status-reason' declared for Immunization. required: false schema: type: string - name: target-disease in: query description: FHIR search parameter 'target-disease' declared for Immunization. required: false schema: type: string - name: vaccine-code in: query description: FHIR search parameter 'vaccine-code' declared for Immunization. required: false schema: type: string responses: '200': description: A Bundle of matching Immunization resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Immunization/{id}: get: operationId: readImmunization summary: Read a Immunization resource by id tags: - Immunization description: Retrieve a single Immunization resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Immunization resource. schema: type: string responses: '200': description: The requested Immunization resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ImmunizationRecommendation: get: operationId: searchImmunizationRecommendation summary: Search ImmunizationRecommendation resources description: Search for ImmunizationRecommendation resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - ImmunizationRecommendation parameters: - name: patient in: query description: The FHIR id of a patient whose immunization recommendations you'd like to obtain. Only one of either patient or subject needs to be specified. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for ImmunizationRecommendation. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for ImmunizationRecommendation. required: false schema: type: string - name: information in: query description: FHIR search parameter 'information' declared for ImmunizationRecommendation. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for ImmunizationRecommendation. required: false schema: type: string - name: support in: query description: FHIR search parameter 'support' declared for ImmunizationRecommendation. required: false schema: type: string - name: target-disease in: query description: FHIR search parameter 'target-disease' declared for ImmunizationRecommendation. required: false schema: type: string - name: vaccine-type in: query description: FHIR search parameter 'vaccine-type' declared for ImmunizationRecommendation. required: false schema: type: string responses: '200': description: A Bundle of matching ImmunizationRecommendation resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ImmunizationRecommendation/{id}: get: operationId: readImmunizationRecommendation summary: Read a ImmunizationRecommendation resource by id tags: - ImmunizationRecommendation description: Retrieve a single ImmunizationRecommendation resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the ImmunizationRecommendation resource. schema: type: string responses: '200': description: The requested ImmunizationRecommendation resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /List: get: operationId: searchList summary: Search List resources description: Search for List resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - List parameters: - name: code in: query description: Refine a search for List resources by list type. Accepted values include "medications," "allergies," "immunizations," "problems," "pedigree-list," "hospital-problems," and "patients." required: false schema: type: string - name: encounter in: query description: Refine a search for List resources by encounter. required: false schema: type: string - name: identifier in: query description: Refine a search for List resource by internal identifier. Only applies to the Patient List sub-resource. required: false schema: type: string - name: patient in: query description: Refine a search for List resources by patient. You can use "patient" or "subject" equivalently, but not at the same time with different references. required: false schema: type: string - name: subject in: query description: Refine a search for List resources by patient. You can use "patient" or "subject" equivalently, but not at the same time with different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for List. required: false schema: type: string - name: empty-reason in: query description: FHIR search parameter 'empty-reason' declared for List. required: false schema: type: string - name: item in: query description: FHIR search parameter 'item' declared for List. required: false schema: type: string - name: notes in: query description: FHIR search parameter 'notes' declared for List. required: false schema: type: string - name: source in: query description: FHIR search parameter 'source' declared for List. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for List. required: false schema: type: string - name: title in: query description: FHIR search parameter 'title' declared for List. required: false schema: type: string responses: '200': description: A Bundle of matching List resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /List/{id}: get: operationId: readList summary: Read a List resource by id tags: - List description: Retrieve a single List resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the List resource. schema: type: string responses: '200': description: The requested List resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Location: get: operationId: searchLocation summary: Search Location resources description: Search for Location resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Location parameters: - name: type in: query description: Search for Location resources with a specified location type. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: address in: query description: FHIR search parameter 'address' declared for Location. required: false schema: type: string - name: address-city in: query description: FHIR search parameter 'address-city' declared for Location. required: false schema: type: string - name: address-country in: query description: FHIR search parameter 'address-country' declared for Location. required: false schema: type: string - name: address-postalcode in: query description: FHIR search parameter 'address-postalcode' declared for Location. required: false schema: type: string - name: address-state in: query description: FHIR search parameter 'address-state' declared for Location. required: false schema: type: string - name: address-use in: query description: FHIR search parameter 'address-use' declared for Location. required: false schema: type: string - name: endpoint in: query description: FHIR search parameter 'endpoint' declared for Location. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Location. required: false schema: type: string - name: name in: query description: FHIR search parameter 'name' declared for Location. required: false schema: type: string - name: operational-status in: query description: FHIR search parameter 'operational-status' declared for Location. required: false schema: type: string - name: organization in: query description: FHIR search parameter 'organization' declared for Location. required: false schema: type: string - name: partof in: query description: FHIR search parameter 'partof' declared for Location. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for Location. required: false schema: type: string responses: '200': description: A Bundle of matching Location resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Location/{id}: get: operationId: readLocation summary: Read a Location resource by id tags: - Location description: Retrieve a single Location resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Location resource. schema: type: string responses: '200': description: The requested Location resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Measure: get: operationId: searchMeasure summary: Search Measure resources description: Search for Measure resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Measure parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Measure resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Measure/{id}: get: operationId: readMeasure summary: Read a Measure resource by id tags: - Measure description: Retrieve a single Measure resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Measure resource. schema: type: string responses: '200': description: The requested Measure resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /MeasureReport: get: operationId: searchMeasureReport summary: Search MeasureReport resources description: Search for MeasureReport resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - MeasureReport parameters: - name: epic-group-id in: query description: FHIR search parameter 'epic-group-id' declared for MeasureReport. required: false schema: type: string - name: patient in: query description: FHIR search parameter 'patient' declared for MeasureReport. required: false schema: type: string - name: subject in: query description: FHIR search parameter 'subject' declared for MeasureReport. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: _lastupdated in: query description: FHIR search parameter '_lastupdated' declared for MeasureReport. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for MeasureReport. required: false schema: type: string - name: evaluated-resource in: query description: FHIR search parameter 'evaluated-resource' declared for MeasureReport. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for MeasureReport. required: false schema: type: string - name: measure in: query description: FHIR search parameter 'measure' declared for MeasureReport. required: false schema: type: string - name: period in: query description: FHIR search parameter 'period' declared for MeasureReport. required: false schema: type: string - name: reporter in: query description: FHIR search parameter 'reporter' declared for MeasureReport. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for MeasureReport. required: false schema: type: string responses: '200': description: A Bundle of matching MeasureReport resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /MeasureReport/{id}: get: operationId: readMeasureReport summary: Read a MeasureReport resource by id tags: - MeasureReport description: Retrieve a single MeasureReport resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the MeasureReport resource. schema: type: string responses: '200': description: The requested MeasureReport resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Media: get: operationId: searchMedia summary: Search Media resources description: Search for Media resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Media parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Media resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Media/{id}: get: operationId: readMedia summary: Read a Media resource by id tags: - Media description: Retrieve a single Media resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Media resource. schema: type: string responses: '200': description: The requested Media resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Medication: get: operationId: searchMedication summary: Search Medication resources description: Search for Medication resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Medication parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Medication resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Medication/{id}: get: operationId: readMedication summary: Read a Medication resource by id tags: - Medication description: Retrieve a single Medication resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Medication resource. schema: type: string responses: '200': description: The requested Medication resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /MedicationAdministration: get: operationId: searchMedicationAdministration summary: Search MedicationAdministration resources description: Search for MedicationAdministration resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - MedicationAdministration parameters: - name: context in: query description: Refine a search for MedicationAdministration resources with one or more linked reference. required: false schema: type: string - name: effective-time in: query description: Refine a search for MedicationAdministration resources for a given patient by specifying a date or a range of dates for the administration. required: false schema: type: string - name: patient in: query description: Search for MedicationAdministration resources for a specified patient ID. You can use "patient" and "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: performer in: query description: Refine a search for MedicationAdministration resources by one or more associated reference. required: false schema: type: string - name: request in: query description: Refine a search for MedicationAdministration resources by associated reference. required: false schema: type: string - name: status in: query description: Refine a search for MedicationAdministration resources with one or more statuses. required: false schema: type: string - name: subject in: query description: Search for MedicationAdministration resources for a specified patient ID. You can use "patient" and "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: code in: query description: FHIR search parameter 'code' declared for MedicationAdministration. required: false schema: type: string - name: device in: query description: FHIR search parameter 'device' declared for MedicationAdministration. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for MedicationAdministration. required: false schema: type: string - name: medication in: query description: FHIR search parameter 'medication' declared for MedicationAdministration. required: false schema: type: string - name: reason-given in: query description: FHIR search parameter 'reason-given' declared for MedicationAdministration. required: false schema: type: string - name: reason-not-given in: query description: FHIR search parameter 'reason-not-given' declared for MedicationAdministration. required: false schema: type: string responses: '200': description: A Bundle of matching MedicationAdministration resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /MedicationAdministration/{id}: get: operationId: readMedicationAdministration summary: Read a MedicationAdministration resource by id tags: - MedicationAdministration description: Retrieve a single MedicationAdministration resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the MedicationAdministration resource. schema: type: string responses: '200': description: The requested MedicationAdministration resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /MedicationDispense: get: operationId: searchMedicationDispense summary: Search MedicationDispense resources description: Search for MedicationDispense resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - MedicationDispense parameters: - name: category in: query description: Refine a search for MedicationDispense resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, community, discharge, and the Netherlands specific SNOMED code 422037009 are supported. required: false schema: type: string - name: patient in: query description: Search for MedicationDispense resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: subject in: query description: Search for MedicationDispense resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: code in: query description: FHIR search parameter 'code' declared for MedicationDispense. required: false schema: type: string - name: context in: query description: FHIR search parameter 'context' declared for MedicationDispense. required: false schema: type: string - name: destination in: query description: FHIR search parameter 'destination' declared for MedicationDispense. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for MedicationDispense. required: false schema: type: string - name: medication in: query description: FHIR search parameter 'medication' declared for MedicationDispense. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for MedicationDispense. required: false schema: type: string - name: prescription in: query description: FHIR search parameter 'prescription' declared for MedicationDispense. required: false schema: type: string - name: receiver in: query description: FHIR search parameter 'receiver' declared for MedicationDispense. required: false schema: type: string - name: responsibleparty in: query description: FHIR search parameter 'responsibleparty' declared for MedicationDispense. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for MedicationDispense. required: false schema: type: string - name: type in: query description: FHIR search parameter 'type' declared for MedicationDispense. required: false schema: type: string - name: whenhandedover in: query description: FHIR search parameter 'whenhandedover' declared for MedicationDispense. required: false schema: type: string - name: whenprepared in: query description: FHIR search parameter 'whenprepared' declared for MedicationDispense. required: false schema: type: string responses: '200': description: A Bundle of matching MedicationDispense resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /MedicationDispense/{id}: get: operationId: readMedicationDispense summary: Read a MedicationDispense resource by id tags: - MedicationDispense description: Retrieve a single MedicationDispense resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the MedicationDispense resource. schema: type: string responses: '200': description: The requested MedicationDispense resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /MedicationRequest: get: operationId: searchMedicationRequest summary: Search MedicationRequest resources description: Search for MedicationRequest resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - MedicationRequest parameters: - name: category in: query description: Refine a search for MedicationRequest resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, community, and discharge are supported. required: false schema: type: string - name: date in: query description: Refine a search for MedicationRequest resources for a given patient by specifying a date or a range of dates for when the medication was activated. required: false schema: type: string - name: intent in: query description: Refine a search for MedicationRequest resources by one or more intents. required: false schema: type: string - name: patient in: query description: Search for MedicationRequest resources for a specified patient ID. You can use "patient" and "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: status in: query description: Refine a search for MedicationRequest resources by one or more statuses. required: false schema: type: string - name: subject in: query description: Search for MedicationRequest resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: authoredon in: query description: FHIR search parameter 'authoredon' declared for MedicationRequest. required: false schema: type: string - name: code in: query description: FHIR search parameter 'code' declared for MedicationRequest. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for MedicationRequest. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for MedicationRequest. required: false schema: type: string - name: intended-dispenser in: query description: FHIR search parameter 'intended-dispenser' declared for MedicationRequest. required: false schema: type: string - name: intended-performer in: query description: FHIR search parameter 'intended-performer' declared for MedicationRequest. required: false schema: type: string - name: intended-performertype in: query description: FHIR search parameter 'intended-performertype' declared for MedicationRequest. required: false schema: type: string - name: medication in: query description: FHIR search parameter 'medication' declared for MedicationRequest. required: false schema: type: string - name: priority in: query description: FHIR search parameter 'priority' declared for MedicationRequest. required: false schema: type: string - name: requester in: query description: FHIR search parameter 'requester' declared for MedicationRequest. required: false schema: type: string responses: '200': description: A Bundle of matching MedicationRequest resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /MedicationRequest/{id}: get: operationId: readMedicationRequest summary: Read a MedicationRequest resource by id tags: - MedicationRequest description: Retrieve a single MedicationRequest resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the MedicationRequest resource. schema: type: string responses: '200': description: The requested MedicationRequest resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /NutritionOrder: get: operationId: searchNutritionOrder summary: Search NutritionOrder resources description: Search for NutritionOrder resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - NutritionOrder parameters: - name: patient in: query description: Search for NutritionOrder resources for the specified patient ID. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: additive in: query description: FHIR search parameter 'additive' declared for NutritionOrder. required: false schema: type: string - name: datetime in: query description: FHIR search parameter 'datetime' declared for NutritionOrder. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for NutritionOrder. required: false schema: type: string - name: formula in: query description: FHIR search parameter 'formula' declared for NutritionOrder. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for NutritionOrder. required: false schema: type: string - name: instantiates-canonical in: query description: FHIR search parameter 'instantiates-canonical' declared for NutritionOrder. required: false schema: type: string - name: oraldiet in: query description: FHIR search parameter 'oraldiet' declared for NutritionOrder. required: false schema: type: string - name: provider in: query description: FHIR search parameter 'provider' declared for NutritionOrder. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for NutritionOrder. required: false schema: type: string - name: supplement in: query description: FHIR search parameter 'supplement' declared for NutritionOrder. required: false schema: type: string responses: '200': description: A Bundle of matching NutritionOrder resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /NutritionOrder/{id}: get: operationId: readNutritionOrder summary: Read a NutritionOrder resource by id tags: - NutritionOrder description: Retrieve a single NutritionOrder resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the NutritionOrder resource. schema: type: string responses: '200': description: The requested NutritionOrder resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Observation: get: operationId: searchObservation summary: Search Observation resources description: Search for Observation resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Observation parameters: - name: based-on in: query description: Refine a search for Observation resources by specifying a Reference associated with the Observation. required: false schema: type: string - name: category in: query description: Refine a search for Observation resources by category or SNOMED code. Epic categories are laboratory, vital-signs, social-history, core-characteristics, LDA, LDA-property, LDA-assessment, functional-mental-status, periodontal, labor-delivery, newborn-delivery, obstetrics-gynecology, survey, sdoh, and imaging. Supported SNOMED codes include 384821006, 118228005, 252275004, 275711006, 68793005, 395124008, 314076009, 19851009, and 405825005. required: false schema: type: string - name: code in: query description: Refine a search for Observation resources by LOINC code, SNOMED code, flowsheet row IDs, or SmartData Identifiers. Codes associated with the labor-delivery and newborn-delivery categories require that the category be specified. required: false schema: type: string - name: date in: query description: Refine a search for Observation resources by specifying a date or date range that an Observation was resulted or recorded. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included. required: false schema: type: string - name: focus in: query description: Refine a search for Observation resources by specifying a Reference associated with the Observation. required: false schema: type: string - name: issued in: query description: Refine a search for Observation resources by specifying a date or date range that an Observation was made available. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included. required: false schema: type: string - name: patient in: query description: Search for Observation resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: subject in: query description: Search for Observation resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: combo-code in: query description: FHIR search parameter 'combo-code' declared for Observation. required: false schema: type: string - name: combo-data-absent-reason in: query description: FHIR search parameter 'combo-data-absent-reason' declared for Observation. required: false schema: type: string - name: combo-value-concept in: query description: FHIR search parameter 'combo-value-concept' declared for Observation. required: false schema: type: string - name: component-code in: query description: FHIR search parameter 'component-code' declared for Observation. required: false schema: type: string - name: component-data-absent-reason in: query description: FHIR search parameter 'component-data-absent-reason' declared for Observation. required: false schema: type: string - name: component-value-concept in: query description: FHIR search parameter 'component-value-concept' declared for Observation. required: false schema: type: string - name: data-absent-reason in: query description: FHIR search parameter 'data-absent-reason' declared for Observation. required: false schema: type: string - name: derived-from in: query description: FHIR search parameter 'derived-from' declared for Observation. required: false schema: type: string - name: device in: query description: FHIR search parameter 'device' declared for Observation. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for Observation. required: false schema: type: string - name: has-member in: query description: FHIR search parameter 'has-member' declared for Observation. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Observation. required: false schema: type: string - name: method in: query description: FHIR search parameter 'method' declared for Observation. required: false schema: type: string - name: part-of in: query description: FHIR search parameter 'part-of' declared for Observation. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for Observation. required: false schema: type: string - name: specimen in: query description: FHIR search parameter 'specimen' declared for Observation. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for Observation. required: false schema: type: string - name: value-concept in: query description: FHIR search parameter 'value-concept' declared for Observation. required: false schema: type: string - name: value-date in: query description: FHIR search parameter 'value-date' declared for Observation. required: false schema: type: string - name: value-string in: query description: FHIR search parameter 'value-string' declared for Observation. required: false schema: type: string responses: '200': description: A Bundle of matching Observation resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createObservation summary: Create a Observation resource tags: - Observation description: Create a new Observation resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The Observation resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /Observation/{id}: get: operationId: readObservation summary: Read a Observation resource by id tags: - Observation description: Retrieve a single Observation resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Observation resource. schema: type: string responses: '200': description: The requested Observation resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: operationId: updateObservation summary: Update a Observation resource tags: - Observation description: Update an existing Observation resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Observation resource. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: The Observation resource was updated. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Organization: get: operationId: searchOrganization summary: Search Organization resources description: Search for Organization resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Organization parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Organization resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Organization/{id}: get: operationId: readOrganization summary: Read a Organization resource by id tags: - Organization description: Retrieve a single Organization resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Organization resource. schema: type: string responses: '200': description: The requested Organization resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Patient: get: operationId: searchPatient summary: Search Patient resources description: Search for Patient resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Patient parameters: - name: address in: query description: Search for Patient resources using an address string. required: false schema: type: string - name: address-city in: query description: Search for Patient resources using the city for a patient's home address. You can use this parameter along with other address parameters. required: false schema: type: string - name: address-postalcode in: query description: Search for Patient resources using the postal code for a patient's home address. You can use this parameter along with other address parameters. required: false schema: type: string - name: address-state in: query description: Search for Patient resources using the state for a patient's home address. You can use this parameter along with other address parameters. required: false schema: type: string - name: birthdate in: query description: Search for Patient resources using a date of birth in ISO format (YYYY-MM-DD). required: false schema: type: string - name: doc-type in: query description: Search for Patient resources using Singapore document type. This parameter is only used in Singapore environment and is only respected if a Singapore document ID is passed in as one of the identifiers. required: false schema: type: string - name: family in: query description: Search for Patient resources by family (last) name. You can use the family parameter along with other name parameters to search by a patient's name. Family name searching supports exact matching, "sounds like" matching, and patient aliases. required: false schema: type: string - name: gender in: query description: 'Search for Patient resources using the following gender codes: female, male, other, or unknown.' required: false schema: type: string - name: given in: query description: Search for Patient resources by given (first) name. You can use the given parameter along with other name parameters to search by a patient's name. Given name searching supports both exact and "sounds like" matches. Patient aliases and dominant name aliases (ex. Bob for Robert) are also supported. required: false schema: type: string - name: identifier in: query description: Search for Patient resources by a patient's identifier. You can use the identifier parameter as the only parameter in a search or in conjunction with other parameters. A patient's identifier must be in the format {|} or {|}. required: false schema: type: string - name: legal-sex in: query description: 'Search for Patient resources using the following gender codes: female, male, nonbinary, x, other, or unknown.' required: false schema: type: string - name: name in: query description: Search for Patient resources by a patient's name. To search on specific name parts use the name part parameters, such as family or given. This parameter is ignored if any name part parameters are used. required: false schema: type: string - name: own-name in: query description: Search for Patient resources by patient's own last name, usually used in non-US names. You can use the own-name parameter along with other name parameters to search by a patient's name. required: false schema: type: string - name: own-prefix in: query description: Search for Patient resources by patient's own last name prefix, usually used in non-US names. You can use the own-prefix parameter along with other name parameters to search by a patient's name, but own-name must also be included. required: false schema: type: string - name: partner-name in: query description: Search for Patient resources by patient's spouse's last name, usually used in non-US names. You can use the partner-name parameter along with other name parameters to search by a patient's name, but own-name must also be included. required: false schema: type: string - name: partner-prefix in: query description: Search for Patient resources by patient's spouse's last name prefix, usually used in non-US names. You can use the partner-prefix parameter along with other name parameters to search by a patient's name, but own-name must also be included. required: false schema: type: string - name: telecom in: query description: Search for Patient resources using a patient's home phone number, cell phone number, or email address. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: active in: query description: FHIR search parameter 'active' declared for Patient. required: false schema: type: string - name: address-country in: query description: FHIR search parameter 'address-country' declared for Patient. required: false schema: type: string - name: address-use in: query description: FHIR search parameter 'address-use' declared for Patient. required: false schema: type: string - name: death-date in: query description: FHIR search parameter 'death-date' declared for Patient. required: false schema: type: string - name: email in: query description: FHIR search parameter 'email' declared for Patient. required: false schema: type: string - name: general-practitioner in: query description: FHIR search parameter 'general-practitioner' declared for Patient. required: false schema: type: string - name: language in: query description: FHIR search parameter 'language' declared for Patient. required: false schema: type: string - name: link in: query description: FHIR search parameter 'link' declared for Patient. required: false schema: type: string - name: organization in: query description: FHIR search parameter 'organization' declared for Patient. required: false schema: type: string - name: phone in: query description: FHIR search parameter 'phone' declared for Patient. required: false schema: type: string - name: phonetic in: query description: FHIR search parameter 'phonetic' declared for Patient. required: false schema: type: string responses: '200': description: A Bundle of matching Patient resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createPatient summary: Create a Patient resource tags: - Patient description: Create a new Patient resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The Patient resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /Patient/{id}: get: operationId: readPatient summary: Read a Patient resource by id tags: - Patient description: Retrieve a single Patient resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Patient resource. schema: type: string responses: '200': description: The requested Patient resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Practitioner: get: operationId: searchPractitioner summary: Search Practitioner resources description: Search for Practitioner resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Practitioner parameters: - name: address in: query description: Any part of an address (street, city, etc.) where a practitioner can be visited. When used, family is also required. Only respected if no other address parameters are populated. Only the first instance of this parameter is respected. required: false schema: type: string - name: address-city in: query description: The city where a practitioner can be visited. When used, address-state is also required. Only the first instance of this parameter is respected. required: false schema: type: string - name: address-postalcode in: query description: The zip code where a practitioner can be found. When used, family is also required. required: false schema: type: string - name: address-state in: query description: The state where a practitioner can be found. When used, family is also required. Only the first instance of this parameter is respected. required: false schema: type: string - name: family in: query description: A practitioner's family (last) name. Only the first instance of this parameter is respected. required: false schema: type: string - name: given in: query description: A practitioner's given (first) name. When used, family is also required. Only the first instance of this parameter is respected. required: false schema: type: string - name: identifier in: query description: A practitioner's identifier in the format |. When this parameter is provided, all others (except _id) are ignored. required: false schema: type: string - name: name in: query description: Any part of a practitioner's name. For full names, format should be first last. When specified, family and given are ignored. Only the first instance of this parameter is respected. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: active in: query description: FHIR search parameter 'active' declared for Practitioner. required: false schema: type: string - name: address-country in: query description: FHIR search parameter 'address-country' declared for Practitioner. required: false schema: type: string - name: address-use in: query description: FHIR search parameter 'address-use' declared for Practitioner. required: false schema: type: string - name: communication in: query description: FHIR search parameter 'communication' declared for Practitioner. required: false schema: type: string - name: email in: query description: FHIR search parameter 'email' declared for Practitioner. required: false schema: type: string - name: gender in: query description: FHIR search parameter 'gender' declared for Practitioner. required: false schema: type: string - name: phone in: query description: FHIR search parameter 'phone' declared for Practitioner. required: false schema: type: string - name: phonetic in: query description: FHIR search parameter 'phonetic' declared for Practitioner. required: false schema: type: string - name: telecom in: query description: FHIR search parameter 'telecom' declared for Practitioner. required: false schema: type: string responses: '200': description: A Bundle of matching Practitioner resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Practitioner/{id}: get: operationId: readPractitioner summary: Read a Practitioner resource by id tags: - Practitioner description: Retrieve a single Practitioner resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Practitioner resource. schema: type: string responses: '200': description: The requested Practitioner resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /PractitionerRole: get: operationId: searchPractitionerRole summary: Search PractitionerRole resources description: Search for PractitionerRole resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - PractitionerRole parameters: - name: email in: query description: Refine a search for a PractitionerRole by entering a valid email address. Code system is ignored. required: false schema: type: string - name: identifier in: query description: Search for PractitionerRoles using identifiers. A code system is required. The code must be prepended with URN:OID. Some codes may need to be URL encoded prior to query. required: false schema: type: string - name: location in: query description: Search for PractitionerRoles using a Location ID. Only the first instance of this parameter is respected. required: false schema: type: string - name: organization in: query description: Search for PractitionerRoles using an Organization ID. Only the first instance of this parameter is respected. required: false schema: type: string - name: phone in: query description: Refine a search for a PractitionerRole by entering a valid phone number. Code system is ignored. required: false schema: type: string - name: practitioner in: query description: Search for PractitionerRoles for a specified Practitioner ID. Only the first instance of this parameter is respected. required: false schema: type: string - name: role in: query description: Refine a search for a PractitionerRole by entering a valid role. System must be included. required: false schema: type: string - name: specialty in: query description: Search for PractitionerRoles for a given specialty. A code system is required. Depending on the organization, NUCC may be supported. required: false schema: type: string - name: telecom in: query description: Refine a search for a PractitionerRole for a specific telecom. System must be specified as either 'phone' or 'email' required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: active in: query description: FHIR search parameter 'active' declared for PractitionerRole. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for PractitionerRole. required: false schema: type: string - name: endpoint in: query description: FHIR search parameter 'endpoint' declared for PractitionerRole. required: false schema: type: string - name: service in: query description: FHIR search parameter 'service' declared for PractitionerRole. required: false schema: type: string responses: '200': description: A Bundle of matching PractitionerRole resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /PractitionerRole/{id}: get: operationId: readPractitionerRole summary: Read a PractitionerRole resource by id tags: - PractitionerRole description: Retrieve a single PractitionerRole resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the PractitionerRole resource. schema: type: string responses: '200': description: The requested PractitionerRole resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Procedure: get: operationId: searchProcedure summary: Search Procedure resources description: Search for Procedure resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Procedure parameters: - name: category in: query description: 'Refine a search for Procedure resources by category. Only the following values are supported: 103693007 (diagnostic procedures), 387713003 (surgical procedures), 9632001 (nursing procedures, Netherlands only), 225317005 or freedom-restricting-intervention (restricting intervention, Netherlands only), and 410606002 (SDOH intervention) are supported.' required: false schema: type: string - name: code in: query description: Refine a search for Procedure based on code. required: false schema: type: string - name: date in: query description: Refine a search for Procedure resources by specifying a date or date range that a Procedure was resulted. Enter dates in ISO format (YYYY[-MM[-DD]]). required: false schema: type: string - name: identifier in: query description: Refine a search for Procedure by identifier. required: false schema: type: string - name: patient in: query description: Search for Procedure resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: subject in: query description: Search for Procedure resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: based-on in: query description: FHIR search parameter 'based-on' declared for Procedure. required: false schema: type: string - name: encounter in: query description: FHIR search parameter 'encounter' declared for Procedure. required: false schema: type: string - name: instantiates-canonical in: query description: FHIR search parameter 'instantiates-canonical' declared for Procedure. required: false schema: type: string - name: location in: query description: FHIR search parameter 'location' declared for Procedure. required: false schema: type: string - name: part-of in: query description: FHIR search parameter 'part-of' declared for Procedure. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for Procedure. required: false schema: type: string - name: reason-code in: query description: FHIR search parameter 'reason-code' declared for Procedure. required: false schema: type: string - name: reason-reference in: query description: FHIR search parameter 'reason-reference' declared for Procedure. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for Procedure. required: false schema: type: string responses: '200': description: A Bundle of matching Procedure resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createProcedure summary: Create a Procedure resource tags: - Procedure description: Create a new Procedure resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The Procedure resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /Procedure/{id}: get: operationId: readProcedure summary: Read a Procedure resource by id tags: - Procedure description: Retrieve a single Procedure resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Procedure resource. schema: type: string responses: '200': description: The requested Procedure resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: operationId: updateProcedure summary: Update a Procedure resource tags: - Procedure description: Update an existing Procedure resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Procedure resource. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: The Procedure resource was updated. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Provenance/{id}: get: operationId: readProvenance summary: Read a Provenance resource by id tags: - Provenance description: Retrieve a single Provenance resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Provenance resource. schema: type: string responses: '200': description: The requested Provenance resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Questionnaire: get: operationId: searchQuestionnaire summary: Search Questionnaire resources description: Search for Questionnaire resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Questionnaire parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Questionnaire resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Questionnaire/{id}: get: operationId: readQuestionnaire summary: Read a Questionnaire resource by id tags: - Questionnaire description: Retrieve a single Questionnaire resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Questionnaire resource. schema: type: string responses: '200': description: The requested Questionnaire resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /QuestionnaireResponse: get: operationId: searchQuestionnaireResponse summary: Search QuestionnaireResponse resources description: Search for QuestionnaireResponse resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - QuestionnaireResponse parameters: - name: encounter in: query description: Search for QuestionnaireResponses by encounter required: false schema: type: string - name: patient in: query description: Search for QuestionnaireResponses for a specified patient. You can also use "subject" equivalently required: false schema: type: string - name: subject in: query description: Search for QuestionnaireResponses for a specified patient or research subject. You can also use "patient" equivalently if subject references a patient. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: author in: query description: FHIR search parameter 'author' declared for QuestionnaireResponse. required: false schema: type: string - name: authored in: query description: FHIR search parameter 'authored' declared for QuestionnaireResponse. required: false schema: type: string - name: based-on in: query description: FHIR search parameter 'based-on' declared for QuestionnaireResponse. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for QuestionnaireResponse. required: false schema: type: string - name: part-of in: query description: FHIR search parameter 'part-of' declared for QuestionnaireResponse. required: false schema: type: string - name: questionnaire in: query description: FHIR search parameter 'questionnaire' declared for QuestionnaireResponse. required: false schema: type: string - name: source in: query description: FHIR search parameter 'source' declared for QuestionnaireResponse. required: false schema: type: string - name: status in: query description: FHIR search parameter 'status' declared for QuestionnaireResponse. required: false schema: type: string responses: '200': description: A Bundle of matching QuestionnaireResponse resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createQuestionnaireResponse summary: Create a QuestionnaireResponse resource tags: - QuestionnaireResponse description: Create a new QuestionnaireResponse resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The QuestionnaireResponse resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /QuestionnaireResponse/{id}: get: operationId: readQuestionnaireResponse summary: Read a QuestionnaireResponse resource by id tags: - QuestionnaireResponse description: Retrieve a single QuestionnaireResponse resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the QuestionnaireResponse resource. schema: type: string responses: '200': description: The requested QuestionnaireResponse resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /RelatedPerson: get: operationId: searchRelatedPerson summary: Search RelatedPerson resources description: Search for RelatedPerson resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - RelatedPerson parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching RelatedPerson resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /RelatedPerson/{id}: get: operationId: readRelatedPerson summary: Read a RelatedPerson resource by id tags: - RelatedPerson description: Retrieve a single RelatedPerson resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the RelatedPerson resource. schema: type: string responses: '200': description: The requested RelatedPerson resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /RequestGroup: get: operationId: searchRequestGroup summary: Search RequestGroup resources description: Search for RequestGroup resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - RequestGroup parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching RequestGroup resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /RequestGroup/{id}: get: operationId: readRequestGroup summary: Read a RequestGroup resource by id tags: - RequestGroup description: Retrieve a single RequestGroup resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the RequestGroup resource. schema: type: string responses: '200': description: The requested RequestGroup resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ResearchStudy: get: operationId: searchResearchStudy summary: Search ResearchStudy resources description: Search for ResearchStudy resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - ResearchStudy parameters: - name: identifier in: query description: Search for the ResearchStudy resource for a specified study code or NCT number required: false schema: type: string - name: status in: query description: Search for the ResearchStudy resource for a specified status required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: category in: query description: FHIR search parameter 'category' declared for ResearchStudy. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for ResearchStudy. required: false schema: type: string - name: focus in: query description: FHIR search parameter 'focus' declared for ResearchStudy. required: false schema: type: string - name: keyword in: query description: FHIR search parameter 'keyword' declared for ResearchStudy. required: false schema: type: string - name: location in: query description: FHIR search parameter 'location' declared for ResearchStudy. required: false schema: type: string - name: partof in: query description: FHIR search parameter 'partof' declared for ResearchStudy. required: false schema: type: string - name: principalinvestigator in: query description: FHIR search parameter 'principalinvestigator' declared for ResearchStudy. required: false schema: type: string - name: protocol in: query description: FHIR search parameter 'protocol' declared for ResearchStudy. required: false schema: type: string - name: site in: query description: FHIR search parameter 'site' declared for ResearchStudy. required: false schema: type: string - name: sponsor in: query description: FHIR search parameter 'sponsor' declared for ResearchStudy. required: false schema: type: string - name: title in: query description: FHIR search parameter 'title' declared for ResearchStudy. required: false schema: type: string responses: '200': description: A Bundle of matching ResearchStudy resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ResearchStudy/{id}: get: operationId: readResearchStudy summary: Read a ResearchStudy resource by id tags: - ResearchStudy description: Retrieve a single ResearchStudy resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the ResearchStudy resource. schema: type: string responses: '200': description: The requested ResearchStudy resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ResearchSubject: get: operationId: searchResearchSubject summary: Search ResearchSubject resources description: Search for ResearchSubject resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - ResearchSubject parameters: - name: patient in: query description: Search for the ResearchSubject resources related to a specified patient required: false schema: type: string - name: status in: query description: Search for the ResearchSubject resources for a specified status. required: false schema: type: string - name: study in: query description: Search for the ResearchSubject resources related to a specified study required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: date in: query description: FHIR search parameter 'date' declared for ResearchSubject. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for ResearchSubject. required: false schema: type: string responses: '200': description: A Bundle of matching ResearchSubject resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ResearchSubject/{id}: get: operationId: readResearchSubject summary: Read a ResearchSubject resource by id tags: - ResearchSubject description: Retrieve a single ResearchSubject resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the ResearchSubject resource. schema: type: string responses: '200': description: The requested ResearchSubject resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ServiceRequest: get: operationId: searchServiceRequest summary: Search ServiceRequest resources description: Search for ServiceRequest resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - ServiceRequest parameters: - name: authored in: query description: Refine a search for ServiceRequests for a particular date and time. By default, all ServiceRequests are returned. required: false schema: type: string - name: category in: query description: Refine a search for ServiceRequests of a particular category. By default, all ServiceRequests are returned. required: false schema: type: string - name: code in: query description: Refine a search for ServiceRequest based on code. By default all service requests are returned. required: false schema: type: string - name: encounter in: query description: Search for ServiceRequest resources for specific encounters. If not provided, all ServiceRequest results are returned. required: false schema: type: string - name: identifier in: query description: Refine a search for ServiceRequest by identifier. required: false schema: type: string - name: onlyscannable in: query description: Refine a search for ServiceRequest resources to scannable only. By default, all ServiceRequests are returned. Use a value of "true" to only return scannable ServiceRequests. Can only be used when the application is launched from Hyperspace. required: false schema: type: string - name: patient in: query description: Search ServiceRequest resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: requester in: query description: Refine a search for ServiceRequest resources by individual making the request. By default, all ServiceRequests are returned. required: false schema: type: string - name: status in: query description: Refine a search for ServiceRequest resources by status. By default, all ServiceRequests are returned. Statuses of draft, active, completed, revoked, and unknown are supported. required: false schema: type: string - name: subject in: query description: Search ServiceRequest resources for a specified patient ID. You can use "patient" or "subject" equivalently but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: based-on in: query description: FHIR search parameter 'based-on' declared for ServiceRequest. required: false schema: type: string - name: body-site in: query description: FHIR search parameter 'body-site' declared for ServiceRequest. required: false schema: type: string - name: instantiates-canonical in: query description: FHIR search parameter 'instantiates-canonical' declared for ServiceRequest. required: false schema: type: string - name: intent in: query description: FHIR search parameter 'intent' declared for ServiceRequest. required: false schema: type: string - name: occurrence in: query description: FHIR search parameter 'occurrence' declared for ServiceRequest. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for ServiceRequest. required: false schema: type: string - name: performer-type in: query description: FHIR search parameter 'performer-type' declared for ServiceRequest. required: false schema: type: string - name: priority in: query description: FHIR search parameter 'priority' declared for ServiceRequest. required: false schema: type: string - name: replaces in: query description: FHIR search parameter 'replaces' declared for ServiceRequest. required: false schema: type: string - name: requisition in: query description: FHIR search parameter 'requisition' declared for ServiceRequest. required: false schema: type: string - name: specimen in: query description: FHIR search parameter 'specimen' declared for ServiceRequest. required: false schema: type: string responses: '200': description: A Bundle of matching ServiceRequest resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: operationId: createServiceRequest summary: Create a ServiceRequest resource tags: - ServiceRequest description: Create a new ServiceRequest resource. requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: The ServiceRequest resource was created. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /ServiceRequest/{id}: get: operationId: readServiceRequest summary: Read a ServiceRequest resource by id tags: - ServiceRequest description: Retrieve a single ServiceRequest resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the ServiceRequest resource. schema: type: string responses: '200': description: The requested ServiceRequest resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: operationId: updateServiceRequest summary: Update a ServiceRequest resource tags: - ServiceRequest description: Update an existing ServiceRequest resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the ServiceRequest resource. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: The ServiceRequest resource was updated. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Specimen: get: operationId: searchSpecimen summary: Search Specimen resources description: Search for Specimen resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Specimen parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Specimen resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Specimen/{id}: get: operationId: readSpecimen summary: Read a Specimen resource by id tags: - Specimen description: Retrieve a single Specimen resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Specimen resource. schema: type: string responses: '200': description: The requested Specimen resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Substance: get: operationId: searchSubstance summary: Search Substance resources description: Search for Substance resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Substance parameters: - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string responses: '200': description: A Bundle of matching Substance resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Substance/{id}: get: operationId: readSubstance summary: Read a Substance resource by id tags: - Substance description: Retrieve a single Substance resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Substance resource. schema: type: string responses: '200': description: The requested Substance resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Task: get: operationId: searchTask summary: Search Task resources description: Search for Task resources. Declared search parameters come verbatim from the server's CapabilityStatement. tags: - Task parameters: - name: code in: query description: Specify community-resource for CRRN tasks, episode-checklist for Episode Checklist tasks. When nothing is specified, all valid tasks are returned. required: false schema: type: string - name: encounter in: query description: Further refine the search for a task by specifying the encounter associated with the task. required: false schema: type: string - name: focus in: query description: FHIR search parameter 'focus' declared for Task. required: false schema: type: string - name: patient in: query description: Search for Task resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: status in: query description: Restrict the search for tasks based on task status. required: false schema: type: string - name: subject in: query description: Search for Task resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references. required: false schema: type: string - name: _count in: query description: Number of results per page. required: false schema: type: string - name: _id in: query description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored. required: false schema: type: string - name: authored-on in: query description: FHIR search parameter 'authored-on' declared for Task. required: false schema: type: string - name: based-on in: query description: FHIR search parameter 'based-on' declared for Task. required: false schema: type: string - name: business-status in: query description: FHIR search parameter 'business-status' declared for Task. required: false schema: type: string - name: group-identifier in: query description: FHIR search parameter 'group-identifier' declared for Task. required: false schema: type: string - name: identifier in: query description: FHIR search parameter 'identifier' declared for Task. required: false schema: type: string - name: intent in: query description: FHIR search parameter 'intent' declared for Task. required: false schema: type: string - name: modified in: query description: FHIR search parameter 'modified' declared for Task. required: false schema: type: string - name: owner in: query description: FHIR search parameter 'owner' declared for Task. required: false schema: type: string - name: part-of in: query description: FHIR search parameter 'part-of' declared for Task. required: false schema: type: string - name: performer in: query description: FHIR search parameter 'performer' declared for Task. required: false schema: type: string - name: period in: query description: FHIR search parameter 'period' declared for Task. required: false schema: type: string - name: priority in: query description: FHIR search parameter 'priority' declared for Task. required: false schema: type: string - name: requester in: query description: FHIR search parameter 'requester' declared for Task. required: false schema: type: string responses: '200': description: A Bundle of matching Task resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /Task/{id}: get: operationId: readTask summary: Read a Task resource by id tags: - Task description: Retrieve a single Task resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Task resource. schema: type: string responses: '200': description: The requested Task resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: operationId: updateTask summary: Update a Task resource tags: - Task description: Update an existing Task resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the Task resource. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: The Task resource was updated. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /ValueSet/{id}: get: operationId: readValueSet summary: Read a ValueSet resource by id tags: - ValueSet description: Retrieve a single ValueSet resource by its logical id. parameters: - name: id in: path required: true description: Logical id of the ValueSet resource. schema: type: string responses: '200': description: The requested ValueSet resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: securitySchemes: smartOnFhir: type: oauth2 description: SMART on FHIR OAuth 2.0 as advertised by the server's .well-known/smart-configuration. flows: authorizationCode: authorizationUrl: https://epicproxy.et0948.epichosted.com/FhirProxy/oauth2/authorize tokenUrl: https://epicproxy.et0948.epichosted.com/FhirProxy/oauth2/token scopes: openid: OpenID Connect authentication profile: Profile claims fhirUser: Identity of the authorized FHIR user launch: EHR launch context epic.scanning.dmsusername: Epic document-management scanning username responses: BadRequest: description: Malformed request. content: application/fhir+json: schema: &id001 $ref: '#/components/schemas/OperationOutcome' Unauthorized: description: Missing or invalid OAuth 2.0 access token. content: application/fhir+json: schema: *id001 Forbidden: description: The token does not carry the scope required for this resource. content: application/fhir+json: schema: *id001 NotFound: description: No resource of this type with that id. content: application/fhir+json: schema: *id001 schemas: Resource: type: object description: A FHIR R4 resource. Structure is defined by HL7 FHIR R4 and the declared US Core profiles. properties: resourceType: type: string id: type: string required: - resourceType Bundle: type: object description: A FHIR R4 searchset Bundle. properties: resourceType: type: string const: Bundle type: type: string total: type: integer link: type: array items: type: object properties: relation: type: string url: type: string format: uri entry: type: array items: type: object properties: fullUrl: type: string resource: $ref: '#/components/schemas/Resource' required: - resourceType - type OperationOutcome: type: object description: FHIR R4 OperationOutcome — the error envelope this server returns. properties: resourceType: type: string const: OperationOutcome issue: type: array items: type: object properties: severity: type: string enum: - fatal - error - warning - information code: type: string diagnostics: type: string details: type: object properties: coding: type: array items: type: object properties: system: type: string code: type: string display: type: string text: type: string required: - resourceType - issue