openapi: 3.1.0 info: title: Oracle Health Millennium Platform FHIR R4 API version: 4.0.1 summary: HL7 FHIR R4 API for Oracle Health Millennium Platform (formerly Cerner Millennium). description: 'REST surface of the Oracle Health Millennium Platform FHIR R4 API, derived operation-for-operation from the CapabilityStatement Oracle Health serves at `/metadata` on the secure sandbox tenant, and from the SMART on FHIR discovery document served at `/.well-known/smart-configuration`. Every path, interaction, search parameter and OAuth scope in this document is present in one of those two provider-served resources; nothing was authored by hand. Millennium is multi-tenant: the tenant id is a required path segment of the service root, so the server variable `{tenant}` must be bound before any call. The open endpoint (`fhir-open.cerner.com`) is read-only and unauthenticated; the secure endpoints require SMART on FHIR OAuth 2.0.' contact: name: Oracle Health Developer Program url: https://www.oracle.com/health/developer/ x-derived-from: capability_statement: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/metadata smart_configuration: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/.well-known/smart-configuration fetched: '2026-08-14' x-fhir-instantiates: - http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server - http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data x-fhir-patch-formats: - application/json-patch+json externalDocs: description: Oracle Health Millennium Platform FHIR R4 API documentation url: https://docs.oracle.com/en/industries/health/millennium-platform-apis/mfrap/index.html servers: - url: https://fhir-ehr-code.cerner.com/r4/{tenant} description: Secure endpoint for provider / non-patient personas (also the secure sandbox). variables: tenant: default: ec2458f2-1e24-41c8-b71b-0e701af7583d description: Millennium tenant id. The sandbox default is the Oracle Health public sandbox tenant. - url: https://fhir-myrecord.cerner.com/r4/{tenant} description: Secure endpoint for patient-access personas. variables: tenant: default: ec2458f2-1e24-41c8-b71b-0e701af7583d description: Millennium tenant id. - url: https://fhir-open.cerner.com/r4/{tenant} description: Open, unauthenticated, read-only endpoint. variables: tenant: default: ec2458f2-1e24-41c8-b71b-0e701af7583d description: Millennium tenant id. security: - smartOnFhir: [] tags: - name: Account description: FHIR R4 Account resource as implemented by Oracle Health Millennium Platform. - name: AllergyIntolerance description: FHIR R4 AllergyIntolerance resource as implemented by Oracle Health Millennium Platform. - name: Appointment description: FHIR R4 Appointment resource as implemented by Oracle Health Millennium Platform. - name: Basic description: FHIR R4 Basic resource as implemented by Oracle Health Millennium Platform. - name: Binary description: FHIR R4 Binary resource as implemented by Oracle Health Millennium Platform. - name: CapabilityStatement description: FHIR R4 CapabilityStatement resource as implemented by Oracle Health Millennium Platform. - name: CarePlan description: FHIR R4 CarePlan resource as implemented by Oracle Health Millennium Platform. - name: CareTeam description: FHIR R4 CareTeam resource as implemented by Oracle Health Millennium Platform. - name: ChargeItem description: FHIR R4 ChargeItem resource as implemented by Oracle Health Millennium Platform. - name: Communication description: FHIR R4 Communication resource as implemented by Oracle Health Millennium Platform. - name: Condition description: FHIR R4 Condition resource as implemented by Oracle Health Millennium Platform. - name: Consent description: FHIR R4 Consent resource as implemented by Oracle Health Millennium Platform. - name: Coverage description: FHIR R4 Coverage resource as implemented by Oracle Health Millennium Platform. - name: Device description: FHIR R4 Device resource as implemented by Oracle Health Millennium Platform. - name: DiagnosticReport description: FHIR R4 DiagnosticReport resource as implemented by Oracle Health Millennium Platform. - name: DocumentReference description: FHIR R4 DocumentReference resource as implemented by Oracle Health Millennium Platform. - name: Encounter description: FHIR R4 Encounter resource as implemented by Oracle Health Millennium Platform. - name: FamilyMemberHistory description: FHIR R4 FamilyMemberHistory resource as implemented by Oracle Health Millennium Platform. - name: Goal description: FHIR R4 Goal resource as implemented by Oracle Health Millennium Platform. - name: Group description: FHIR R4 Group resource as implemented by Oracle Health Millennium Platform. - name: Immunization description: FHIR R4 Immunization resource as implemented by Oracle Health Millennium Platform. - name: InsurancePlan description: FHIR R4 InsurancePlan resource as implemented by Oracle Health Millennium Platform. - name: Location description: FHIR R4 Location resource as implemented by Oracle Health Millennium Platform. - name: Media description: FHIR R4 Media resource as implemented by Oracle Health Millennium Platform. - name: MedicationAdministration description: FHIR R4 MedicationAdministration resource as implemented by Oracle Health Millennium Platform. - name: MedicationDispense description: FHIR R4 MedicationDispense resource as implemented by Oracle Health Millennium Platform. - name: MedicationRequest description: FHIR R4 MedicationRequest resource as implemented by Oracle Health Millennium Platform. - name: NutritionOrder description: FHIR R4 NutritionOrder resource as implemented by Oracle Health Millennium Platform. - name: Observation description: FHIR R4 Observation resource as implemented by Oracle Health Millennium Platform. - name: OperationDefinition description: FHIR R4 OperationDefinition resource as implemented by Oracle Health Millennium Platform. - name: Organization description: FHIR R4 Organization resource as implemented by Oracle Health Millennium Platform. - name: Patient description: FHIR R4 Patient resource as implemented by Oracle Health Millennium Platform. - name: Person description: FHIR R4 Person resource as implemented by Oracle Health Millennium Platform. - name: Practitioner description: FHIR R4 Practitioner resource as implemented by Oracle Health Millennium Platform. - name: Procedure description: FHIR R4 Procedure resource as implemented by Oracle Health Millennium Platform. - name: Provenance description: FHIR R4 Provenance resource as implemented by Oracle Health Millennium Platform. - name: Questionnaire description: FHIR R4 Questionnaire resource as implemented by Oracle Health Millennium Platform. - name: QuestionnaireResponse description: FHIR R4 QuestionnaireResponse resource as implemented by Oracle Health Millennium Platform. - name: RelatedPerson description: FHIR R4 RelatedPerson resource as implemented by Oracle Health Millennium Platform. - name: Schedule description: FHIR R4 Schedule resource as implemented by Oracle Health Millennium Platform. - name: ServiceRequest description: FHIR R4 ServiceRequest resource as implemented by Oracle Health Millennium Platform. - name: Slot description: FHIR R4 Slot resource as implemented by Oracle Health Millennium Platform. - name: Specimen description: FHIR R4 Specimen resource as implemented by Oracle Health Millennium Platform. - name: StructureDefinition description: FHIR R4 StructureDefinition resource as implemented by Oracle Health Millennium Platform. - name: System description: 'System-level FHIR interactions: conformance metadata and batch.' paths: /Account: get: operationId: searchAccount summary: Search Account description: FHIR R4 `search-type` interaction for Account. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Account parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Account ids. It is a required field if the -guarantor or patient fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The entity that caused the expenses. It is a required field if the _id or -guarantor fields are not given. Must be set with identifier. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Account-patient x-fhir-search-type: reference - name: -encounter in: query required: false schema: type: string description: The encounter associated with the resource. x-fhir-search-type: reference - name: -guarantor in: query required: false schema: type: string description: The entity that responsible for payment. It is a required field if the _id or patient fields are not given. x-fhir-search-type: reference - name: type in: query required: false schema: type: string description: The identifier for the account. Required in every search request. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Account-type x-fhir-search-type: token - name: identifier in: query required: false schema: type: string description: Statement Account number. Must be set with patients x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Account-identifier x-fhir-search-type: token - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. Not honored when '_id' is set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of Account resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Account/{id}: get: operationId: readAccount summary: Read Account description: FHIR R4 `read` interaction for Account. tags: - Account responses: '200': description: The requested Account resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Account resource. schema: type: string /AllergyIntolerance: get: operationId: searchAllergyIntolerance summary: Search AllergyIntolerance description: FHIR R4 `search-type` interaction for AllergyIntolerance. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - AllergyIntolerance parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of AllergyIntolerance ids. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: Who the sensitivity is for. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient x-fhir-search-type: reference - name: clinical-status in: query required: false schema: type: string description: Certainty of the allergy or intolerance. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status x-fhir-search-type: token - name: _lastUpdated in: query required: false schema: type: string description: A date or date range used to search for AllergyIntolerance records which were last updated in that period. The '_lastUpdated' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for AllergyIntolerance records at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for AllergyIntolerance records within a specific range. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date responses: '200': description: A FHIR searchset Bundle of AllergyIntolerance resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id001 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance x-fhir-update-create: false post: operationId: createAllergyIntolerance summary: Create AllergyIntolerance description: FHIR R4 `create` interaction for AllergyIntolerance. tags: - AllergyIntolerance requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: AllergyIntolerance created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id001 x-fhir-update-create: false /AllergyIntolerance/{id}: get: operationId: readAllergyIntolerance summary: Read AllergyIntolerance description: FHIR R4 `read` interaction for AllergyIntolerance. tags: - AllergyIntolerance responses: '200': description: The requested AllergyIntolerance resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id001 x-fhir-update-create: false put: operationId: updateAllergyIntolerance summary: Update AllergyIntolerance description: FHIR R4 `update` interaction for AllergyIntolerance. Supply `If-Match` with the current version to avoid a 409 Conflict on a stale write. tags: - AllergyIntolerance parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date update with 409 Conflict. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: AllergyIntolerance updated. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id001 x-fhir-update-create: false parameters: - name: id in: path required: true description: Logical id of the AllergyIntolerance resource. schema: type: string /Appointment: get: operationId: searchAppointment summary: Search Appointment description: FHIR R4 `search-type` interaction for Appointment. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Appointment parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Appointment ids. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. Not honored when '_id' is set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number - name: date in: query required: false schema: type: string description: A date or date range from which to find appointments. This or the '-date-or-req-period' parameter must be set when using patient, practitioner or location. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Appointment-date x-fhir-search-type: date - name: -date-or-req-period in: query required: false schema: type: string description: A start date or requested period from which to find appointments. This or the 'date' parameter must be set when using patient, practitioner or location. The '-date-or-req-period' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range. x-fhir-search-type: date - name: patient in: query required: false schema: type: string description: One of the individuals of the appointment is this patient. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Appointment-patient x-fhir-search-type: reference - name: practitioner in: query required: false schema: type: string description: One of the individuals of the appointment is this practitioner. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Appointment-practitioner x-fhir-search-type: reference - name: location in: query required: false schema: type: string description: This location is listed in the participants of the appointment. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Appointment-location x-fhir-search-type: reference - name: status in: query required: false schema: type: string description: The overall status of the appointment. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Appointment-status x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of Appointment resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' post: operationId: createAppointment summary: Create Appointment description: FHIR R4 `create` interaction for Appointment. tags: - Appointment requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Appointment created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Appointment/{id}: get: operationId: readAppointment summary: Read Appointment description: FHIR R4 `read` interaction for Appointment. tags: - Appointment responses: '200': description: The requested Appointment resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' patch: operationId: patchAppointment summary: Patch Appointment description: FHIR R4 `patch` interaction for Appointment. The server advertises the JSON Patch and FHIRPath patch formats in `CapabilityStatement.patchFormat`. tags: - Appointment parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date patch with 409 Conflict. schema: type: string requestBody: required: true content: application/json-patch+json: schema: type: array items: type: object responses: '200': description: Appointment patched. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Appointment resource. schema: type: string /Basic: post: operationId: createBasic summary: Create Basic description: FHIR R4 `create` interaction for Basic. tags: - Basic requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Basic created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Binary/{id}: get: operationId: readBinary summary: Read Binary description: FHIR R4 `read` interaction for Binary. tags: - Binary responses: '200': description: The requested Binary resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Binary resource. schema: type: string /Binary/$autogen-ccd-if: get: operationId: opBinaryAutogenCcdIf summary: $autogen-ccd-if on Binary description: 'Generate Continuity of Care Document (CCD) OperationDefinition: https://fhir-ehr.cerner.com/r4/OperationDefinition/binary-autogen-ccd-if' tags: - Binary x-fhir-operation-definition: https://fhir-ehr.cerner.com/r4/OperationDefinition/binary-autogen-ccd-if responses: '200': description: Operation result. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /CapabilityStatement/{id}: get: operationId: readCapabilityStatement summary: Read CapabilityStatement description: FHIR R4 `read` interaction for CapabilityStatement. tags: - CapabilityStatement responses: '200': description: The requested CapabilityStatement resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the CapabilityStatement resource. schema: type: string /CarePlan: get: operationId: searchCarePlan summary: Search CarePlan description: FHIR R4 `search-type` interaction for CarePlan. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - CarePlan parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of CarePlan ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: date in: query required: false schema: type: string description: A date range with which to find CarePlans. If used, the ‘date’ parameter must be provided twice. Once with a 'ge' prefix representing the earliest date, and once with a 'le’ prefix representing the latest date. The date prefix pair must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date x-fhir-search-type: date - name: patient in: query required: false schema: type: string description: Who the careplan is for. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient x-fhir-search-type: reference - name: category in: query required: false schema: type: string description: The category of the careplan. Category assess-plan is supported as of now. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category x-fhir-search-type: token - name: _count in: query required: false schema: type: number description: The maximum number of results to return. Not honored when '_id' is set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of CarePlan resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id002 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan /CarePlan/{id}: get: operationId: readCarePlan summary: Read CarePlan description: FHIR R4 `read` interaction for CarePlan. tags: - CarePlan responses: '200': description: The requested CarePlan resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id002 parameters: - name: id in: path required: true description: Logical id of the CarePlan resource. schema: type: string /CareTeam: get: operationId: searchCareTeam summary: Search CareTeam description: FHIR R4 `search-type` interaction for CareTeam. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - CareTeam parameters: - name: _id in: query required: false schema: type: string description: CareTeam id supports only the single id. It is a required field if the patient or encounter fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: category in: query required: false schema: type: string description: The category of the careteam. Category Longitudinal (patient level) or Encounter is supported as of now. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/CareTeam-category x-fhir-search-type: token - name: encounter in: query required: false schema: type: string description: The Encounter level CareTeam are displayed. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-encounter x-fhir-search-type: reference - name: patient in: query required: false schema: type: string description: Who the careteam is for. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient x-fhir-search-type: reference - name: status in: query required: false schema: type: string description: The status of the CareTeam. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of CareTeam resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id003 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam /CareTeam/{id}: get: operationId: readCareTeam summary: Read CareTeam description: FHIR R4 `read` interaction for CareTeam. tags: - CareTeam responses: '200': description: The requested CareTeam resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id003 parameters: - name: id in: path required: true description: Logical id of the CareTeam resource. schema: type: string /ChargeItem: get: operationId: searchChargeItem summary: Search ChargeItem description: FHIR R4 `search-type` interaction for ChargeItem. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - ChargeItem parameters: - name: _id in: query required: false schema: type: string description: ChargeItem id supports only the single id. It is a required field if the account or context fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: context in: query required: false schema: type: string description: Encounter associated with the ChargeItem. If provided, the '-status' parameter must also be provided. It is a required field if the _id or account fields are not given. x-fhir-search-type: reference - name: account in: query required: false schema: type: string description: Account associated with the ChargeItem. If provided, the '-status' parameter must also be provided. It is a required field if the _id or context fields are not given. x-fhir-search-type: reference - name: -status in: query required: false schema: type: string description: The status of the ChargeItem. Must be set to 'billable'. Must be provided with the context and account parameter. x-fhir-search-type: token - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. Not honored when '_id' is set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of ChargeItem resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /ChargeItem/{id}: get: operationId: readChargeItem summary: Read ChargeItem description: FHIR R4 `read` interaction for ChargeItem. tags: - ChargeItem responses: '200': description: The requested ChargeItem resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the ChargeItem resource. schema: type: string /ChargeItem/$credit: get: operationId: opChargeItemCredit summary: $credit on ChargeItem description: 'Creates an offsetting ChargeItem for an existing debit ChargeItem. OperationDefinition: https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-credit' tags: - ChargeItem x-fhir-operation-definition: https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-credit responses: '200': description: Operation result. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /ChargeItem/$modify: get: operationId: opChargeItemModify summary: $modify on ChargeItem description: 'Modifies an existing ChargeItem resulting in a newly created ChargeItem. OperationDefinition: https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-modify' tags: - ChargeItem x-fhir-operation-definition: https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-modify responses: '200': description: Operation result. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /ChargeItem/$create: get: operationId: opChargeItemCreate summary: $create on ChargeItem description: 'Creates a charge event which can result in the creation of one or more ChargeItems. OperationDefinition: https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-create' tags: - ChargeItem x-fhir-operation-definition: https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-create responses: '200': description: Operation result. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Communication: get: operationId: searchCommunication summary: Search Communication description: FHIR R4 `search-type` interaction for Communication. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Communication parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Communication ids. It is a required field if the category, -email-status, received and recipient fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: category in: query required: false schema: type: string description: The message category. It is a required field if the _id field is not given. Must be set with received, recipient and -email-status. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Communication-category x-fhir-search-type: token - name: received in: query required: false schema: type: string description: When the message is received. It is a required field if the _id field is not given. Must be set with category, recipient and -email-status. If used, the ‘received’ parameter may be provided once or twice. Once with a 'ge' prefix representing the earliest received date, and/or once with a 'le’ prefix representing the latest received date. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Communication-received x-fhir-search-type: date - name: recipient in: query required: false schema: type: string description: The recipient of the message. It is a required field if the _id field is not given. Must be set with category, recipient and -email-status. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Communication-recipient x-fhir-search-type: reference - name: -email-status in: query required: false schema: type: string description: The email status of the message. It is a required field if the _id field is not given. Must be set with category, received and recipient. x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of Communication resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' post: operationId: createCommunication summary: Create Communication description: FHIR R4 `create` interaction for Communication. tags: - Communication requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Communication created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Communication/{id}: get: operationId: readCommunication summary: Read Communication description: FHIR R4 `read` interaction for Communication. tags: - Communication responses: '200': description: The requested Communication resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' patch: operationId: patchCommunication summary: Patch Communication description: FHIR R4 `patch` interaction for Communication. The server advertises the JSON Patch and FHIRPath patch formats in `CapabilityStatement.patchFormat`. tags: - Communication parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date patch with 409 Conflict. schema: type: string requestBody: required: true content: application/json-patch+json: schema: type: array items: type: object responses: '200': description: Communication patched. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Communication resource. schema: type: string /Condition: get: operationId: searchCondition summary: Search Condition description: FHIR R4 `search-type` interaction for Condition. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Condition parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Condition ids. It is a required field if the patient or subject fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: Who has the condition. It is a required field if the subject or _id fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient x-fhir-search-type: reference - name: encounter in: query required: false schema: type: string description: The encounter of the patient. Only encounter-diagnosis are returned. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Condition-encounter x-fhir-search-type: reference - name: subject in: query required: false schema: type: string description: Who has the condition. It is a required field if the patient or _id fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Condition-subject x-fhir-search-type: reference - name: clinical-status in: query required: false schema: type: string description: The clinical status of the condition. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status x-fhir-search-type: token - name: category in: query required: false schema: type: string description: The category of the condition. Categories problem-list-item, encounter-diagnosis and health-concern are supported as of now. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category x-fhir-search-type: token - name: _lastUpdated in: query required: false schema: type: string description: A date or date range used to search for conditions which were last updated in that period. The '_lastUpdated' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for Conditions at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for conditions report within a specific range. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date responses: '200': description: A FHIR searchset Bundle of Condition resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id004 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition - http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis - http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns x-fhir-update-create: false post: operationId: createCondition summary: Create Condition description: FHIR R4 `create` interaction for Condition. tags: - Condition requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Condition created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id004 x-fhir-update-create: false /Condition/{id}: get: operationId: readCondition summary: Read Condition description: FHIR R4 `read` interaction for Condition. tags: - Condition responses: '200': description: The requested Condition resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id004 x-fhir-update-create: false put: operationId: updateCondition summary: Update Condition description: FHIR R4 `update` interaction for Condition. Supply `If-Match` with the current version to avoid a 409 Conflict on a stale write. tags: - Condition parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date update with 409 Conflict. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: Condition updated. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id004 x-fhir-update-create: false parameters: - name: id in: path required: true description: Logical id of the Condition resource. schema: type: string /Consent: get: operationId: searchConsent summary: Search Consent description: FHIR R4 `search-type` interaction for Consent. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Consent parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Consent ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: Who the consent applies to. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-patient x-fhir-search-type: reference - name: actor in: query required: false schema: type: string description: Resource for the actor (or group, by role). It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Consent-actor x-fhir-search-type: reference - name: patient.identifier in: query required: false schema: type: string description: The patient.identifier allows to search by patient aliases. Federated Person Principle, SSN, MRN etc... are supported as of now. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Consent-patient.identifier x-fhir-search-type: token - name: actor.identifier in: query required: false schema: type: string description: The actor.identifier allows to search by related person aliases. Federated Person Principle is the only supported alias as of now. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Consent-actor.identifier x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of Consent resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Consent/{id}: get: operationId: readConsent summary: Read Consent description: FHIR R4 `read` interaction for Consent. tags: - Consent responses: '200': description: The requested Consent resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Consent resource. schema: type: string /Coverage: get: operationId: searchCoverage summary: Search Coverage description: FHIR R4 `search-type` interaction for Coverage. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Coverage parameters: - name: _id in: query required: false schema: type: string x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: Retrieve coverages for a patient. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Coverage-patient x-fhir-search-type: reference - name: -encounter in: query required: false schema: type: string description: Retrieve coverages for an encounter. x-fhir-search-type: reference responses: '200': description: A FHIR searchset Bundle of Coverage resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id005 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage post: operationId: createCoverage summary: Create Coverage description: FHIR R4 `create` interaction for Coverage. tags: - Coverage requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Coverage created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id005 /Coverage/{id}: get: operationId: readCoverage summary: Read Coverage description: FHIR R4 `read` interaction for Coverage. tags: - Coverage responses: '200': description: The requested Coverage resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id005 patch: operationId: patchCoverage summary: Patch Coverage description: FHIR R4 `patch` interaction for Coverage. The server advertises the JSON Patch and FHIRPath patch formats in `CapabilityStatement.patchFormat`. tags: - Coverage parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date patch with 409 Conflict. schema: type: string requestBody: required: true content: application/json-patch+json: schema: type: array items: type: object responses: '200': description: Coverage patched. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id005 delete: operationId: deleteCoverage summary: Delete Coverage description: FHIR R4 `delete` interaction for Coverage. tags: - Coverage responses: '204': description: Coverage deleted. '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id005 parameters: - name: id in: path required: true description: Logical id of the Coverage resource. schema: type: string /Device: get: operationId: searchDevice summary: Search Device description: FHIR R4 `search-type` interaction for Device. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Device parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Device ids. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The patient to whom Device is affixed. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient x-fhir-search-type: reference responses: '200': description: A FHIR searchset Bundle of Device resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id006 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device /Device/{id}: get: operationId: readDevice summary: Read Device description: FHIR R4 `read` interaction for Device. tags: - Device responses: '200': description: The requested Device resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id006 parameters: - name: id in: path required: true description: Logical id of the Device resource. schema: type: string /DiagnosticReport: get: operationId: searchDiagnosticReport summary: Search DiagnosticReport description: FHIR R4 `search-type` interaction for DiagnosticReport. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - DiagnosticReport parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of DiagnosticReport ids. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: category in: query required: false schema: type: string description: Which diagnostic discipline/department created the report. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category x-fhir-search-type: token - name: code in: query required: false schema: type: string description: The code for the report. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code x-fhir-search-type: token - name: encounter in: query required: false schema: type: string description: The Encounter when the report was made. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-encounter x-fhir-search-type: reference - name: patient in: query required: false schema: type: string description: The subject of the report. It is a required field. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient x-fhir-search-type: reference - name: date in: query required: false schema: type: string description: A date range with which to find Documents. A date parameter may be provided once with or without prefix and time component to imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and time component to search for procedures within a specific range. The date and prefix pairs must create a closed range. Must be set with patient or subject. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date x-fhir-search-type: date - name: _lastUpdated in: query required: false schema: type: string description: A date or date range used to search for Documents of diagnostic report which were last updated in that period. The '_lastUpdated' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for Documents of diagnostic report at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for Documents of diagnostic report within a specific range. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of DiagnosticReport resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id007 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note - http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab post: operationId: createDiagnosticReport summary: Create DiagnosticReport description: FHIR R4 `create` interaction for DiagnosticReport. tags: - DiagnosticReport requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: DiagnosticReport created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id007 /DiagnosticReport/{id}: get: operationId: readDiagnosticReport summary: Read DiagnosticReport description: FHIR R4 `read` interaction for DiagnosticReport. tags: - DiagnosticReport responses: '200': description: The requested DiagnosticReport resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id007 parameters: - name: id in: path required: true description: Logical id of the DiagnosticReport resource. schema: type: string /DocumentReference: get: operationId: searchDocumentReference summary: Search DocumentReference description: FHIR R4 `search-type` interaction for DocumentReference. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - DocumentReference parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of DocumentReference ids. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The patient the document is about. It is a required field if the subject field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient x-fhir-search-type: reference - name: encounter in: query required: false schema: type: string description: The Encounter in which the document was created. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-encounter x-fhir-search-type: reference - name: period in: query required: false schema: type: string description: A date range with which to find Documents. If used, the 'period' parameter must be provided twice. Once with a 'ge' prefix representing the earliest date, and once with a 'lt' prefix representing the latest date. The period prefix pair must create a closed range and cannot be equal to each other. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period x-fhir-search-type: date - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number - name: type in: query required: false schema: type: string description: The kind of document (LOINC if possible). x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type x-fhir-search-type: token - name: category in: query required: false schema: type: string description: The categorization of document. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category x-fhir-search-type: token - name: date in: query required: false schema: type: string description: It must be provided once with a prefix to imply a date range or without a prefix to search for document(s) at a specific date. Alternately it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for document(s) within specific range. The date and prefix pairs must create a closed range. For a single 'date' occurrence, `time` component is optional but for two `date` occurrences, must include `time` component. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date x-fhir-search-type: date - name: _lastUpdated in: query required: false schema: type: string description: A date or date range used to search for Documents which were last updated in that period. The '_lastUpdated' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for Documents at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for Documents within a specific range. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date responses: '200': description: A FHIR searchset Bundle of DocumentReference resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id008 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference x-fhir-update-create: false post: operationId: createDocumentReference summary: Create DocumentReference description: FHIR R4 `create` interaction for DocumentReference. tags: - DocumentReference requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: DocumentReference created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id008 x-fhir-update-create: false /DocumentReference/{id}: get: operationId: readDocumentReference summary: Read DocumentReference description: FHIR R4 `read` interaction for DocumentReference. tags: - DocumentReference responses: '200': description: The requested DocumentReference resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id008 x-fhir-update-create: false put: operationId: updateDocumentReference summary: Update DocumentReference description: FHIR R4 `update` interaction for DocumentReference. Supply `If-Match` with the current version to avoid a 409 Conflict on a stale write. tags: - DocumentReference parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date update with 409 Conflict. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: DocumentReference updated. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id008 x-fhir-update-create: false parameters: - name: id in: path required: true description: Logical id of the DocumentReference resource. schema: type: string /DocumentReference/$USCoreFetchDocumentReferences: get: operationId: opDocumentReferenceUscorefetchdocumentreferences summary: $USCoreFetchDocumentReferences on DocumentReference description: 'US Core Fetch DocumentReferences OperationDefinition: http://hl7.org/fhir/us/core/OperationDefinition/docref' tags: - DocumentReference x-fhir-operation-definition: http://hl7.org/fhir/us/core/OperationDefinition/docref responses: '200': description: Operation result. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Encounter: get: operationId: searchEncounter summary: Search Encounter description: FHIR R4 `search-type` interaction for Encounter. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Encounter parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Encounter ids. It is a required field if the account or identifier or -pageContext or patient or subject fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-id x-fhir-search-type: token - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. Not honored when '_id' is set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number - name: patient in: query required: false schema: type: string description: The patient present at the encounter. It is a required field if the account or _id or identifier or -pageContext or subject fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-patient x-fhir-search-type: reference - name: subject in: query required: false schema: type: string description: The patient present at the encounter. It is a required field if the account or _id or identifier or -pageContext or patient fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Encounter-subject x-fhir-search-type: reference - name: status in: query required: false schema: type: string description: The status of the encounter. Must be set with patient. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-status x-fhir-search-type: token - name: date in: query required: false schema: type: string description: A date parameter may be provided once with a prefix and time component to imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and time component to search for encounters within a specific range. The date and prefix pairs must create a closed range. Must be set with patient or subject. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-date x-fhir-search-type: date - name: identifier in: query required: false schema: type: string description: An encounter's identifier. It is a required field if the account or _id or -pageContext or patient or subject fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-identifier x-fhir-search-type: token - name: account in: query required: false schema: type: string description: The account associated with the encounters. This parameter is required if patient, subject, _id, or identifier is not used. x-fhir-search-type: reference - name: _lastUpdated in: query required: false schema: type: string description: A date or date range used to search for Encounter records which were last updated in that period. The '_lastUpdated' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for Encounter records at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for Encounter records within a specific range. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date responses: '200': description: A FHIR searchset Bundle of Encounter resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id009 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter post: operationId: createEncounter summary: Create Encounter description: FHIR R4 `create` interaction for Encounter. tags: - Encounter requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Encounter created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id009 /Encounter/{id}: get: operationId: readEncounter summary: Read Encounter description: FHIR R4 `read` interaction for Encounter. tags: - Encounter responses: '200': description: The requested Encounter resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id009 patch: operationId: patchEncounter summary: Patch Encounter description: FHIR R4 `patch` interaction for Encounter. The server advertises the JSON Patch and FHIRPath patch formats in `CapabilityStatement.patchFormat`. tags: - Encounter parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date patch with 409 Conflict. schema: type: string requestBody: required: true content: application/json-patch+json: schema: type: array items: type: object responses: '200': description: Encounter patched. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id009 parameters: - name: id in: path required: true description: Logical id of the Encounter resource. schema: type: string /FamilyMemberHistory: get: operationId: searchFamilyMemberHistory summary: Search FamilyMemberHistory description: FHIR R4 `search-type` interaction for FamilyMemberHistory. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - FamilyMemberHistory parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of FamilyMemberHistory ids. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: Who the family member history is for. It is a required field if the _id field is not given. It is a required field if the status parameter is provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-patient x-fhir-search-type: reference - name: status in: query required: false schema: type: string description: The status of the FamilyMemberHistory. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/status x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of FamilyMemberHistory resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-update-create: false post: operationId: createFamilyMemberHistory summary: Create FamilyMemberHistory description: FHIR R4 `create` interaction for FamilyMemberHistory. tags: - FamilyMemberHistory requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: FamilyMemberHistory created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-update-create: false /FamilyMemberHistory/{id}: get: operationId: readFamilyMemberHistory summary: Read FamilyMemberHistory description: FHIR R4 `read` interaction for FamilyMemberHistory. tags: - FamilyMemberHistory responses: '200': description: The requested FamilyMemberHistory resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-update-create: false put: operationId: updateFamilyMemberHistory summary: Update FamilyMemberHistory description: FHIR R4 `update` interaction for FamilyMemberHistory. Supply `If-Match` with the current version to avoid a 409 Conflict on a stale write. tags: - FamilyMemberHistory parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date update with 409 Conflict. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: FamilyMemberHistory updated. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-update-create: false parameters: - name: id in: path required: true description: Logical id of the FamilyMemberHistory resource. schema: type: string /Goal: get: operationId: searchGoal summary: Search Goal description: FHIR R4 `search-type` interaction for Goal. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Goal parameters: - name: _id in: query required: false schema: type: string description: Goal id supports only the single id. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: Who has the goal is for. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-patient x-fhir-search-type: reference - name: target-date in: query required: false schema: type: string description: A date or date range from which to find Goals. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-target-date x-fhir-search-type: date responses: '200': description: A FHIR searchset Bundle of Goal resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id010 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal /Goal/{id}: get: operationId: readGoal summary: Read Goal description: FHIR R4 `read` interaction for Goal. tags: - Goal responses: '200': description: The requested Goal resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id010 parameters: - name: id in: path required: true description: Logical id of the Goal resource. schema: type: string /Immunization: get: operationId: searchImmunization summary: Search Immunization description: FHIR R4 `search-type` interaction for Immunization. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Immunization parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Immunization ids. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The patient for the vaccination record. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient x-fhir-search-type: reference - name: _lastUpdated in: query required: false schema: type: string description: Vaccination LastUpdated Date. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date - name: date in: query required: false schema: type: string description: Vaccination (non)-Administration Date. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date x-fhir-search-type: date - name: target-disease in: query required: false schema: type: string description: A single or comma separated list of target diseases the dose is being administered against. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-target-disease x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of Immunization resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id011 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization x-fhir-update-create: false post: operationId: createImmunization summary: Create Immunization description: FHIR R4 `create` interaction for Immunization. tags: - Immunization requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Immunization created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id011 x-fhir-update-create: false /Immunization/{id}: get: operationId: readImmunization summary: Read Immunization description: FHIR R4 `read` interaction for Immunization. tags: - Immunization responses: '200': description: The requested Immunization resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id011 x-fhir-update-create: false put: operationId: updateImmunization summary: Update Immunization description: FHIR R4 `update` interaction for Immunization. Supply `If-Match` with the current version to avoid a 409 Conflict on a stale write. tags: - Immunization parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date update with 409 Conflict. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: Immunization updated. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id011 x-fhir-update-create: false parameters: - name: id in: path required: true description: Logical id of the Immunization resource. schema: type: string /InsurancePlan: get: operationId: searchInsurancePlan summary: Search InsurancePlan description: FHIR R4 `search-type` interaction for InsurancePlan. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - InsurancePlan parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of InsurancePlan ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: owned-by in: query required: false schema: type: string description: The organization that is providing the health insurance product. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/InsurancePlan-owned-by x-fhir-search-type: reference responses: '200': description: A FHIR searchset Bundle of InsurancePlan resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /InsurancePlan/{id}: get: operationId: readInsurancePlan summary: Read InsurancePlan description: FHIR R4 `read` interaction for InsurancePlan. tags: - InsurancePlan responses: '200': description: The requested InsurancePlan resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the InsurancePlan resource. schema: type: string /Location: get: operationId: searchLocation summary: Search Location description: FHIR R4 `search-type` interaction for Location. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Location parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Location ids. It is a required field if the -physicalType field is not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: -physicalType in: query required: false schema: type: string description: The Location's physical type. It is a required field if the _id field is not given x-fhir-search-type: token - name: identifier in: query required: false schema: type: string description: A location's identifier. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-location-identifier x-fhir-search-type: token - name: address in: query required: false schema: type: string description: A (part of the) address of the location x-fhir-search-type: string - name: address-city in: query required: false schema: type: string description: A city specified in an address. It is a required field if the address-state or address-postalcode fields are not given x-fhir-search-type: string - name: address-state in: query required: false schema: type: string description: A state specified in an address x-fhir-search-type: string - name: address-postalcode in: query required: false schema: type: string description: A postal code specified in an address x-fhir-search-type: string - name: name in: query required: false schema: type: string description: A portion of the location's name or alias x-fhir-search-type: string - name: organization in: query required: false schema: type: string description: Searches for locations that are managed by the provided organization x-fhir-search-type: reference - name: type in: query required: false schema: type: string description: The Location's type. It is a required field if the _id field is not given x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of Location resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id012 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-location /Location/{id}: get: operationId: readLocation summary: Read Location description: FHIR R4 `read` interaction for Location. tags: - Location responses: '200': description: The requested Location resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id012 parameters: - name: id in: path required: true description: Logical id of the Location resource. schema: type: string /Media/{id}: get: operationId: readMedia summary: Read Media description: FHIR R4 `read` interaction for Media. tags: - Media responses: '200': description: The requested Media resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Media resource. schema: type: string /MedicationAdministration: get: operationId: searchMedicationAdministration summary: Search MedicationAdministration description: FHIR R4 `search-type` interaction for MedicationAdministration. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - MedicationAdministration parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of MedicationAdministration ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The identity of a patient to list administrations for. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/medicationadministration-patient x-fhir-search-type: reference - name: status in: query required: false schema: type: string description: MedicationAdministration event status. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/medicationadministration-status x-fhir-search-type: token - name: performer in: query required: false schema: type: string description: The identity of the individual who administered the medication. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/medicationadministration-performer x-fhir-search-type: reference - name: effective-time in: query required: false schema: type: string description: A effective-time parameter may be provided once with 'le' or 'lt' or 'ge' or 'gt' prefix and time component to imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and time component to search for medications administered within a specific range. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/medicationadministration-effective-time x-fhir-search-type: date responses: '200': description: A FHIR searchset Bundle of MedicationAdministration resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /MedicationAdministration/{id}: get: operationId: readMedicationAdministration summary: Read MedicationAdministration description: FHIR R4 `read` interaction for MedicationAdministration. tags: - MedicationAdministration responses: '200': description: The requested MedicationAdministration resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the MedicationAdministration resource. schema: type: string /MedicationDispense: get: operationId: searchMedicationDispense summary: Search MedicationDispense description: FHIR R4 `search-type` interaction for MedicationDispense. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - MedicationDispense parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of MedicationDispense ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The identity of a patient to list dispenses for. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/MedicationDispense-patient x-fhir-search-type: reference - name: date in: query required: false schema: type: string description: A date-time used to find medication dispenses. Only a single value is supported. Only 'ge' and 'gt' prefixes are supported. Ranges (multiple values) are not supported. Cannot be used together with '_lastUpdated'. If both are provided, 'date' will be ignored. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/MedicationDispense-whenhandedover x-fhir-search-type: date - name: _lastUpdated in: query required: false schema: type: string description: A date-time used to search for medication dispenses which were last updated in that period. Only a single value is supported and it must include a time component. Only 'ge' and 'gt' prefixes are supported. Ranges (multiple values) are not supported. Cannot be used together with 'date'. If both are provided, 'date' will be ignored. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date - name: _count in: query required: false schema: type: number description: The maximum number of results to return. Not honored when '_id' is set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of MedicationDispense resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id013 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense /MedicationDispense/{id}: get: operationId: readMedicationDispense summary: Read MedicationDispense description: FHIR R4 `read` interaction for MedicationDispense. tags: - MedicationDispense responses: '200': description: The requested MedicationDispense resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id013 parameters: - name: id in: path required: true description: Logical id of the MedicationDispense resource. schema: type: string /MedicationRequest: get: operationId: searchMedicationRequest summary: Search MedicationRequest description: FHIR R4 `search-type` interaction for MedicationRequest. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - MedicationRequest parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of MedicationRequest ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The patient to return MedicationRequests for. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient x-fhir-search-type: reference - name: intent in: query required: false schema: type: string description: The intent of the MedicationRequest. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent x-fhir-search-type: token - name: status in: query required: false schema: type: string description: The status of the MedicationRequest. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status x-fhir-search-type: token - name: _lastUpdated in: query required: false schema: type: string description: When the resource version last changed. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date - name: -timing-boundsPeriod in: query required: false schema: type: string description: The date-time within the period the medication should be given to the patient. Must be prefixed by 'ge'. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-dosageInstruction-timing-repeat-boundsPeriod x-fhir-search-type: date - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. Not honored when '_id' is set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of MedicationRequest resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id014 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest post: operationId: createMedicationRequest summary: Create MedicationRequest description: FHIR R4 `create` interaction for MedicationRequest. tags: - MedicationRequest requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: MedicationRequest created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id014 /MedicationRequest/{id}: get: operationId: readMedicationRequest summary: Read MedicationRequest description: FHIR R4 `read` interaction for MedicationRequest. tags: - MedicationRequest responses: '200': description: The requested MedicationRequest resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id014 patch: operationId: patchMedicationRequest summary: Patch MedicationRequest description: FHIR R4 `patch` interaction for MedicationRequest. The server advertises the JSON Patch and FHIRPath patch formats in `CapabilityStatement.patchFormat`. tags: - MedicationRequest parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date patch with 409 Conflict. schema: type: string requestBody: required: true content: application/json-patch+json: schema: type: array items: type: object responses: '200': description: MedicationRequest patched. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id014 parameters: - name: id in: path required: true description: Logical id of the MedicationRequest resource. schema: type: string /NutritionOrder: get: operationId: searchNutritionOrder summary: Search NutritionOrder description: FHIR R4 `search-type` interaction for NutritionOrder. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - NutritionOrder parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of NutritionOrder ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The patient to return NutritionOrders for. It is a required field if the _id field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-patient x-fhir-search-type: reference - name: status in: query required: false schema: type: string description: The status of the NutritionOrder. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/NutritionOrder-status x-fhir-search-type: token - name: _lastUpdated in: query required: false schema: type: string description: When the resource version last changed. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. Not honored when '_id' is set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of NutritionOrder resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /NutritionOrder/{id}: get: operationId: readNutritionOrder summary: Read NutritionOrder description: FHIR R4 `read` interaction for NutritionOrder. tags: - NutritionOrder responses: '200': description: The requested NutritionOrder resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the NutritionOrder resource. schema: type: string /Observation: get: operationId: searchObservation summary: Search Observation description: FHIR R4 `search-type` interaction for Observation. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Observation parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Observation ids. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The patient the observation is about. It is a required field if the subject field is not given. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient x-fhir-search-type: reference - name: subject in: query required: false schema: type: string description: The patient subject the observation is about. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Observation-subject x-fhir-search-type: reference - name: category in: query required: false schema: type: string description: A single or comma separated list of classifications of the type of observation. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category x-fhir-search-type: token - name: code in: query required: false schema: type: string description: A single or comma separated list of observation types. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code x-fhir-search-type: token - name: date in: query required: false schema: type: string description: A date or date range from which to find observations. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for observations at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for observations within a specific range. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date x-fhir-search-type: date - name: _lastUpdated in: query required: false schema: type: string description: A date or date range used to search for observations which were last updated in that period. The '_lastUpdated' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for observations at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for observations within a specific range. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of Observation resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id015 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab - http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi - http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height - http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry - http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus - http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure - http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height - http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight - http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate - http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate - http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature - http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference - http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs - http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age - http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-occupation - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancystatus - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancyintent - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sdoh-assessment - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-survey - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-screening-assessment - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sexual-orientation x-fhir-update-create: false post: operationId: createObservation summary: Create Observation description: FHIR R4 `create` interaction for Observation. tags: - Observation requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Observation created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id015 x-fhir-update-create: false /Observation/{id}: get: operationId: readObservation summary: Read Observation description: FHIR R4 `read` interaction for Observation. tags: - Observation responses: '200': description: The requested Observation resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id015 x-fhir-update-create: false put: operationId: updateObservation summary: Update Observation description: FHIR R4 `update` interaction for Observation. Supply `If-Match` with the current version to avoid a 409 Conflict on a stale write. tags: - Observation parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date update with 409 Conflict. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: Observation updated. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id015 x-fhir-update-create: false parameters: - name: id in: path required: true description: Logical id of the Observation resource. schema: type: string /OperationDefinition/{id}: get: operationId: readOperationDefinition summary: Read OperationDefinition description: FHIR R4 `read` interaction for OperationDefinition. tags: - OperationDefinition responses: '200': description: The requested OperationDefinition resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the OperationDefinition resource. schema: type: string /Organization: get: operationId: searchOrganization summary: Search Organization description: FHIR R4 `search-type` interaction for Organization. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Organization parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Organization ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: identifier in: query required: false schema: type: string description: The Organization's Identifier. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Organization-identifier x-fhir-search-type: token - name: type in: query required: false schema: type: string description: The Organization's type. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Organization-type x-fhir-search-type: token - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Organization-count x-fhir-search-type: number - name: name in: query required: false schema: type: string description: The Organization's name. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Organization-name x-fhir-search-type: string - name: address in: query required: false schema: type: string description: The Organization's address. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Organization-address x-fhir-search-type: string responses: '200': description: A FHIR searchset Bundle of Organization resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id016 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization post: operationId: createOrganization summary: Create Organization description: FHIR R4 `create` interaction for Organization. tags: - Organization requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Organization created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id016 /Organization/{id}: get: operationId: readOrganization summary: Read Organization description: FHIR R4 `read` interaction for Organization. tags: - Organization responses: '200': description: The requested Organization resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id016 parameters: - name: id in: path required: true description: Logical id of the Organization resource. schema: type: string /Organization/$get-cg-for-mrcu: get: operationId: opOrganizationGetCgForMrcu summary: $get-cg-for-mrcu on Organization description: 'Retrieves details for a caregiver organization given a care unit organization id. OperationDefinition: https://fhir-ehr.cerner.com/r4/OperationDefinition/organization-get-cg-for-mrcu' tags: - Organization x-fhir-operation-definition: https://fhir-ehr.cerner.com/r4/OperationDefinition/organization-get-cg-for-mrcu responses: '200': description: Operation result. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Patient: get: operationId: searchPatient summary: Search Patient description: FHIR R4 `search-type` interaction for Patient. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Patient parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Patient ids. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id x-fhir-search-type: token - name: identifier in: query required: false schema: type: string description: A patient identifier. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier x-fhir-search-type: token - name: name in: query required: false schema: type: string description: The beginning of any name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name x-fhir-search-type: string - name: given in: query required: false schema: type: string description: The beginning of the given name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given x-fhir-search-type: string - name: family in: query required: false schema: type: string description: The beginning of the family name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family x-fhir-search-type: string - name: address-postalcode in: query required: false schema: type: string description: The postal code of the address of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/individual-address-postalcode x-fhir-search-type: string - name: birthdate in: query required: false schema: type: string description: The date of birth of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate x-fhir-search-type: date - name: phone in: query required: false schema: type: string description: The value of the phone number of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/individual-phone x-fhir-search-type: token - name: email in: query required: false schema: type: string description: The value of the email address of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/individual-email x-fhir-search-type: token - name: gender in: query required: false schema: type: string description: The administrative gender of the patient. Gender may only be provided if another parameter other than '_id' is provided x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender x-fhir-search-type: token - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. Not honored when '_id' or 'identifier' are set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of Patient resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id017 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient post: operationId: createPatient summary: Create Patient description: FHIR R4 `create` interaction for Patient. tags: - Patient requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Patient created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id017 /Patient/{id}: get: operationId: readPatient summary: Read Patient description: FHIR R4 `read` interaction for Patient. tags: - Patient responses: '200': description: The requested Patient resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id017 patch: operationId: patchPatient summary: Patch Patient description: FHIR R4 `patch` interaction for Patient. The server advertises the JSON Patch and FHIRPath patch formats in `CapabilityStatement.patchFormat`. tags: - Patient parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date patch with 409 Conflict. schema: type: string requestBody: required: true content: application/json-patch+json: schema: type: array items: type: object responses: '200': description: Patient patched. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id017 parameters: - name: id in: path required: true description: Logical id of the Patient resource. schema: type: string /Patient/$health-cards-issue: get: operationId: opPatientHealthCardsIssue summary: $health-cards-issue on Patient description: 'Issues verifiable health cards for the patient. OperationDefinition: https://spec.smarthealth.cards/artifacts/operation-patient-i-health-cards-issue.json' tags: - Patient x-fhir-operation-definition: https://spec.smarthealth.cards/artifacts/operation-patient-i-health-cards-issue.json responses: '200': description: Operation result. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Person: get: operationId: searchPerson summary: Search Person description: FHIR R4 `search-type` interaction for Person. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Person parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Person ids. It is a required field if the identifier field is not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: identifier in: query required: false schema: type: string description: A person's Identifier. It is a required field if the _id field is not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Person-identifier x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of Person resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Person/{id}: get: operationId: readPerson summary: Read Person description: FHIR R4 `read` interaction for Person. tags: - Person responses: '200': description: The requested Person resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Person resource. schema: type: string /Practitioner: get: operationId: searchPractitioner summary: Search Practitioner description: FHIR R4 `search-type` interaction for Practitioner. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Practitioner parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Practitioner ids. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: identifier in: query required: false schema: type: string description: A practitioner's Identifier. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier x-fhir-search-type: token - name: given in: query required: false schema: type: string description: The beginning of the given name of the practitioner. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/individual-given x-fhir-search-type: string - name: family in: query required: false schema: type: string description: The beginning of the family name of the practitioner. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/individual-family x-fhir-search-type: string - name: name in: query required: false schema: type: string description: The beginning of the first, last or middle name of the practitioner. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/individual-name x-fhir-search-type: string - name: active in: query required: false schema: type: string description: Whether the practitioner record is active. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-active x-fhir-search-type: token - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. Not honored when '_id' is set. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of Practitioner resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id018 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner post: operationId: createPractitioner summary: Create Practitioner description: FHIR R4 `create` interaction for Practitioner. tags: - Practitioner requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Practitioner created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id018 /Practitioner/{id}: get: operationId: readPractitioner summary: Read Practitioner description: FHIR R4 `read` interaction for Practitioner. tags: - Practitioner responses: '200': description: The requested Practitioner resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id018 parameters: - name: id in: path required: true description: Logical id of the Practitioner resource. schema: type: string /Procedure: get: operationId: searchProcedure summary: Search Procedure description: FHIR R4 `search-type` interaction for Procedure. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Procedure parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Procedure ids. It is a required field if the patient or subject fields are not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: Search by subject - a patient. It is a required field if the _id or subject fields are not given x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient x-fhir-search-type: reference - name: subject in: query required: false schema: type: string description: Search by subject. It is a required field if the _id or patient fields are not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-patient x-fhir-search-type: reference - name: date in: query required: false schema: type: string description: A date parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for procedures within a specific range. The date and prefix pairs must create a closed range. Must be set with patient or subject. x-fhir-search-parameter: http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date x-fhir-search-type: date - name: _lastUpdated in: query required: false schema: type: string description: A date or date range used to search for procedures which were last updated in that period. The '_lastUpdated' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for Procedures at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for procedures report within a specific range. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date responses: '200': description: A FHIR searchset Bundle of Procedure resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id019 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure post: operationId: createProcedure summary: Create Procedure description: FHIR R4 `create` interaction for Procedure. tags: - Procedure requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Procedure created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id019 /Procedure/{id}: get: operationId: readProcedure summary: Read Procedure description: FHIR R4 `read` interaction for Procedure. tags: - Procedure responses: '200': description: The requested Procedure resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id019 parameters: - name: id in: path required: true description: Logical id of the Procedure resource. schema: type: string /Provenance: get: operationId: searchProvenance summary: Search Provenance description: FHIR R4 `search-type` interaction for Provenance. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Provenance parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Provenance ids. It is a required field if the target field is not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: target in: query required: false schema: type: string description: The resource(s) the Provenance is associated with. It is a required field if the _id field is not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Provenance-target x-fhir-search-type: reference responses: '200': description: A FHIR searchset Bundle of Provenance resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id020 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance post: operationId: createProvenance summary: Create Provenance description: FHIR R4 `create` interaction for Provenance. tags: - Provenance requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Provenance created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id020 /Provenance/{id}: get: operationId: readProvenance summary: Read Provenance description: FHIR R4 `read` interaction for Provenance. tags: - Provenance responses: '200': description: The requested Provenance resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id020 parameters: - name: id in: path required: true description: Logical id of the Provenance resource. schema: type: string /Questionnaire: get: operationId: searchQuestionnaire summary: Search Questionnaire description: FHIR R4 `search-type` interaction for Questionnaire. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Questionnaire parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Questionnaire ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of Questionnaire resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Questionnaire/{id}: get: operationId: readQuestionnaire summary: Read Questionnaire description: FHIR R4 `read` interaction for Questionnaire. tags: - Questionnaire responses: '200': description: The requested Questionnaire resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Questionnaire resource. schema: type: string /QuestionnaireResponse: get: operationId: searchQuestionnaireResponse summary: Search QuestionnaireResponse description: FHIR R4 `search-type` interaction for QuestionnaireResponse. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - QuestionnaireResponse parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of QuestionnaireResponse ids. It is a required field if the patient field is not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The patient that is the subject of the questionnaire response. It is a required field if the _id field is not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/QuestionnaireResponse-patient x-fhir-search-type: reference responses: '200': description: A FHIR searchset Bundle of QuestionnaireResponse resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-update-create: false /QuestionnaireResponse/{id}: get: operationId: readQuestionnaireResponse summary: Read QuestionnaireResponse description: FHIR R4 `read` interaction for QuestionnaireResponse. tags: - QuestionnaireResponse responses: '200': description: The requested QuestionnaireResponse resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-update-create: false put: operationId: updateQuestionnaireResponse summary: Update QuestionnaireResponse description: FHIR R4 `update` interaction for QuestionnaireResponse. Supply `If-Match` with the current version to avoid a 409 Conflict on a stale write. tags: - QuestionnaireResponse parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date update with 409 Conflict. schema: type: string requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '200': description: QuestionnaireResponse updated. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-update-create: false parameters: - name: id in: path required: true description: Logical id of the QuestionnaireResponse resource. schema: type: string /RelatedPerson: get: operationId: searchRelatedPerson summary: Search RelatedPerson description: FHIR R4 `search-type` interaction for RelatedPerson. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - RelatedPerson parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of RelatedPerson ids. It is a required field if the identifier or patient or -encounter fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: identifier in: query required: false schema: type: string description: An Identifier of the RelatedPerson. It is a required field if the id or patient or -encounter fields are not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Patient-identifier x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The patient this related person is related to. It is a required field if the id or identifier or -encounter fields are not given x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-patient x-fhir-search-type: reference - name: -encounter in: query required: false schema: type: string description: The encounter this related person is related to. It is a required field if the id or identifier or patient fields are not given x-fhir-search-type: reference - name: -relationship-level in: query required: false schema: type: string description: The resource's relationship to either the patient or encounter level. Must be provided with Patient and Identifier searches. x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of RelatedPerson resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id021 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson post: operationId: createRelatedPerson summary: Create RelatedPerson description: FHIR R4 `create` interaction for RelatedPerson. tags: - RelatedPerson requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: RelatedPerson created. The `Location` header carries the new resource URL. headers: Location: description: URL of the created resource. schema: type: string ETag: description: Version identifier of the created resource. schema: type: string '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id021 /RelatedPerson/{id}: get: operationId: readRelatedPerson summary: Read RelatedPerson description: FHIR R4 `read` interaction for RelatedPerson. tags: - RelatedPerson responses: '200': description: The requested RelatedPerson resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id021 patch: operationId: patchRelatedPerson summary: Patch RelatedPerson description: FHIR R4 `patch` interaction for RelatedPerson. The server advertises the JSON Patch and FHIRPath patch formats in `CapabilityStatement.patchFormat`. tags: - RelatedPerson parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date patch with 409 Conflict. schema: type: string requestBody: required: true content: application/json-patch+json: schema: type: array items: type: object responses: '200': description: RelatedPerson patched. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id021 parameters: - name: id in: path required: true description: Logical id of the RelatedPerson resource. schema: type: string /Schedule: get: operationId: searchSchedule summary: Search Schedule description: FHIR R4 `search-type` interaction for Schedule. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Schedule parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Schedule ids. The '_id' parameter must be set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of Schedule resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Schedule/{id}: get: operationId: readSchedule summary: Read Schedule description: FHIR R4 `read` interaction for Schedule. tags: - Schedule responses: '200': description: The requested Schedule resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Schedule resource. schema: type: string /ServiceRequest: get: operationId: searchServiceRequest summary: Search ServiceRequest description: FHIR R4 `search-type` interaction for ServiceRequest. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - ServiceRequest parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of ServiceRequest ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: patient in: query required: false schema: type: string description: The patient to return ServiceRequests for. It is a required field if the subject or _id fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-patient x-fhir-search-type: reference - name: subject in: query required: false schema: type: string description: Individual or Entity the service is ordered for. It is a required field if the patient or _id fields are not given. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/ServiceRequest-subject x-fhir-search-type: reference - name: code in: query required: false schema: type: string description: What is being requested/ordered. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/clinical-code x-fhir-search-type: token - name: _lastUpdated in: query required: false schema: type: string description: When the resource version last changed. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated x-fhir-search-type: date - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. Not honored when '_id' is set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of ServiceRequest resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id022 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest /ServiceRequest/{id}: get: operationId: readServiceRequest summary: Read ServiceRequest description: FHIR R4 `read` interaction for ServiceRequest. tags: - ServiceRequest responses: '200': description: The requested ServiceRequest resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id022 parameters: - name: id in: path required: true description: Logical id of the ServiceRequest resource. schema: type: string /Slot: get: operationId: searchSlot summary: Search Slot description: FHIR R4 `search-type` interaction for Slot. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Slot parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Slot ids. Either the '_id' parameter or 'service-type' must be set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token - name: start in: query required: false schema: type: string description: A date or date range from which the slots are to be retrieved. The 'start' parameter is required when service-type, schedule.actor, -location is provided. When provided, must use both 'lt' and 'ge' prefixes to search for slots within a specific range. Time component should be provided for both the instances. The date and prefix pairs must create a closed range. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Slot-date x-fhir-search-type: date - name: service-type in: query required: false schema: type: string description: A single or comma separated list of appointment types that can be booked into the slot. Either the '_id' parameter or 'service-type' must be set. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Service-type x-fhir-search-type: token - name: schedule.actor in: query required: false schema: type: string description: A single or comma separated list of schedule actors. Must be Practitioner actors. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Slot-schedule.actor x-fhir-search-type: reference - name: -location in: query required: false schema: type: string description: A single or comma separated list of Location references. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Slot-location x-fhir-search-type: reference - name: _count in: query required: false schema: type: number description: The maximum number of results to return in a page. This value should be in the range [5,200]. If no value is provided, a default page size of 50 will be used. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-count x-fhir-search-type: number responses: '200': description: A FHIR searchset Bundle of Slot resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /Slot/{id}: get: operationId: readSlot summary: Read Slot description: FHIR R4 `read` interaction for Slot. tags: - Slot responses: '200': description: The requested Slot resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' patch: operationId: patchSlot summary: Patch Slot description: FHIR R4 `patch` interaction for Slot. The server advertises the JSON Patch and FHIRPath patch formats in `CapabilityStatement.patchFormat`. tags: - Slot parameters: - name: If-Match in: header required: false description: Version ETag the client last read; the server rejects an out-of-date patch with 409 Conflict. schema: type: string requestBody: required: true content: application/json-patch+json: schema: type: array items: type: object responses: '200': description: Slot patched. '409': $ref: '#/components/responses/Error409' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the Slot resource. schema: type: string /Specimen: get: operationId: searchSpecimen summary: Search Specimen description: FHIR R4 `search-type` interaction for Specimen. Returns a searchset Bundle. Follow `Bundle.link[relation=next]` for pagination rather than constructing page URLs. tags: - Specimen parameters: - name: _id in: query required: false schema: type: string description: A single or comma separated list of Specimen ids. x-fhir-search-parameter: http://hl7.org/fhir/R4/SearchParameter/Resource-id x-fhir-search-type: token responses: '200': description: A FHIR searchset Bundle of Specimen resources. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: &id023 - http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen /Specimen/{id}: get: operationId: readSpecimen summary: Read Specimen description: FHIR R4 `read` interaction for Specimen. tags: - Specimen responses: '200': description: The requested Specimen resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' x-fhir-supported-profile: *id023 parameters: - name: id in: path required: true description: Logical id of the Specimen resource. schema: type: string /StructureDefinition/{id}: get: operationId: readStructureDefinition summary: Read StructureDefinition description: FHIR R4 `read` interaction for StructureDefinition. tags: - StructureDefinition responses: '200': description: The requested StructureDefinition resource. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' parameters: - name: id in: path required: true description: Logical id of the StructureDefinition resource. schema: type: string /: post: operationId: submitBatch summary: Submit a batch Bundle description: FHIR R4 system-level `batch` interaction. The CapabilityStatement records this as "Implemented per the specification". tags: - System requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' responses: '200': description: A batch-response Bundle. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '406': $ref: '#/components/responses/Error406' '422': $ref: '#/components/responses/Error422' '500': $ref: '#/components/responses/Error500' /metadata: get: operationId: getCapabilityStatement summary: Get the CapabilityStatement description: Returns the FHIR R4 CapabilityStatement for this tenant. Served without authentication. tags: - System security: [] responses: '200': description: The server CapabilityStatement. content: application/fhir+json: schema: $ref: '#/components/schemas/Resource' components: securitySchemes: smartOnFhir: type: oauth2 description: 'SMART on FHIR OAuth 2.0. Endpoints are tenant-scoped and are discovered per tenant from `/.well-known/smart-configuration`. Client authentication methods advertised by the server: client_secret_basic, private_key_jwt. PKCE methods: S256.' flows: authorizationCode: authorizationUrl: https://authorization.cerner.com/tenants/{tenant}/protocols/oauth2/profiles/smart-v1/personas/provider/authorize tokenUrl: https://authorization.cerner.com/tenants/{tenant}/hosts/fhir-ehr-code.cerner.com/protocols/oauth2/profiles/smart-v1/token refreshUrl: https://authorization.cerner.com/tenants/{tenant}/hosts/fhir-ehr-code.cerner.com/protocols/oauth2/profiles/smart-v1/token scopes: fhirUser: Identity of the authorizing FHIR user. launch: EHR launch context. offline_access: Refresh token that survives the user session. online_access: Refresh token bound to the user session. openid: OpenID Connect authentication. patient/Account.read: 'Patient-level access: Account.read' patient/Account.rs: 'Patient-level access: Account.rs' patient/AllergyIntolerance.crus: 'Patient-level access: AllergyIntolerance.crus' patient/AllergyIntolerance.read: 'Patient-level access: AllergyIntolerance.read' patient/AllergyIntolerance.write: 'Patient-level access: AllergyIntolerance.write' patient/Appointment.crus: 'Patient-level access: Appointment.crus' patient/Appointment.read: 'Patient-level access: Appointment.read' patient/Appointment.write: 'Patient-level access: Appointment.write' patient/Basic.c: 'Patient-level access: Basic.c' patient/Basic.write: 'Patient-level access: Basic.write' patient/Binary.r: 'Patient-level access: Binary.r' patient/Binary.read: 'Patient-level access: Binary.read' patient/CarePlan.read: 'Patient-level access: CarePlan.read' patient/CarePlan.rs: 'Patient-level access: CarePlan.rs' patient/CareTeam.read: 'Patient-level access: CareTeam.read' patient/CareTeam.rs: 'Patient-level access: CareTeam.rs' patient/ChargeItem.crs: 'Patient-level access: ChargeItem.crs' patient/ChargeItem.read: 'Patient-level access: ChargeItem.read' patient/ChargeItem.write: 'Patient-level access: ChargeItem.write' patient/Communication.crus: 'Patient-level access: Communication.crus' patient/Communication.read: 'Patient-level access: Communication.read' patient/Communication.write: 'Patient-level access: Communication.write' patient/Condition.crus: 'Patient-level access: Condition.crus' patient/Condition.read: 'Patient-level access: Condition.read' patient/Condition.write: 'Patient-level access: Condition.write' patient/Consent.read: 'Patient-level access: Consent.read' patient/Consent.rs: 'Patient-level access: Consent.rs' patient/Coverage.cruds: 'Patient-level access: Coverage.cruds' patient/Coverage.read: 'Patient-level access: Coverage.read' patient/Coverage.write: 'Patient-level access: Coverage.write' patient/Device.read: 'Patient-level access: Device.read' patient/Device.rs: 'Patient-level access: Device.rs' patient/DiagnosticReport.crs: 'Patient-level access: DiagnosticReport.crs' patient/DiagnosticReport.read: 'Patient-level access: DiagnosticReport.read' patient/DiagnosticReport.write: 'Patient-level access: DiagnosticReport.write' patient/DocumentReference.crus: 'Patient-level access: DocumentReference.crus' patient/DocumentReference.read: 'Patient-level access: DocumentReference.read' patient/DocumentReference.write: 'Patient-level access: DocumentReference.write' patient/Encounter.crus: 'Patient-level access: Encounter.crus' patient/Encounter.read: 'Patient-level access: Encounter.read' patient/Encounter.write: 'Patient-level access: Encounter.write' patient/FamilyMemberHistory.crus: 'Patient-level access: FamilyMemberHistory.crus' patient/FamilyMemberHistory.read: 'Patient-level access: FamilyMemberHistory.read' patient/FamilyMemberHistory.write: 'Patient-level access: FamilyMemberHistory.write' patient/Goal.read: 'Patient-level access: Goal.read' patient/Goal.rs: 'Patient-level access: Goal.rs' patient/Immunization.crus: 'Patient-level access: Immunization.crus' patient/Immunization.read: 'Patient-level access: Immunization.read' patient/Immunization.write: 'Patient-level access: Immunization.write' patient/InsurancePlan.read: 'Patient-level access: InsurancePlan.read' patient/InsurancePlan.rs: 'Patient-level access: InsurancePlan.rs' patient/Media.r: 'Patient-level access: Media.r' patient/Media.read: 'Patient-level access: Media.read' patient/MedicationAdministration.read: 'Patient-level access: MedicationAdministration.read' patient/MedicationAdministration.rs: 'Patient-level access: MedicationAdministration.rs' patient/MedicationDispense.read: 'Patient-level access: MedicationDispense.read' patient/MedicationDispense.rs: 'Patient-level access: MedicationDispense.rs' patient/MedicationRequest.crus: 'Patient-level access: MedicationRequest.crus' patient/MedicationRequest.read: 'Patient-level access: MedicationRequest.read' patient/MedicationRequest.write: 'Patient-level access: MedicationRequest.write' patient/NutritionOrder.read: 'Patient-level access: NutritionOrder.read' patient/NutritionOrder.rs: 'Patient-level access: NutritionOrder.rs' patient/Observation.crus: 'Patient-level access: Observation.crus' patient/Observation.read: 'Patient-level access: Observation.read' patient/Observation.write: 'Patient-level access: Observation.write' patient/Patient.crus: 'Patient-level access: Patient.crus' patient/Patient.read: 'Patient-level access: Patient.read' patient/Patient.write: 'Patient-level access: Patient.write' patient/Person.read: 'Patient-level access: Person.read' patient/Person.rs: 'Patient-level access: Person.rs' patient/Procedure.crs: 'Patient-level access: Procedure.crs' patient/Procedure.read: 'Patient-level access: Procedure.read' patient/Procedure.write: 'Patient-level access: Procedure.write' patient/Provenance.crs: 'Patient-level access: Provenance.crs' patient/Provenance.read: 'Patient-level access: Provenance.read' patient/Provenance.write: 'Patient-level access: Provenance.write' patient/Questionnaire.read: 'Patient-level access: Questionnaire.read' patient/Questionnaire.rs: 'Patient-level access: Questionnaire.rs' patient/QuestionnaireResponse.read: 'Patient-level access: QuestionnaireResponse.read' patient/QuestionnaireResponse.rus: 'Patient-level access: QuestionnaireResponse.rus' patient/QuestionnaireResponse.write: 'Patient-level access: QuestionnaireResponse.write' patient/RelatedPerson.crus: 'Patient-level access: RelatedPerson.crus' patient/RelatedPerson.read: 'Patient-level access: RelatedPerson.read' patient/RelatedPerson.write: 'Patient-level access: RelatedPerson.write' patient/Schedule.read: 'Patient-level access: Schedule.read' patient/Schedule.rs: 'Patient-level access: Schedule.rs' patient/ServiceRequest.read: 'Patient-level access: ServiceRequest.read' patient/ServiceRequest.rs: 'Patient-level access: ServiceRequest.rs' patient/Slot.read: 'Patient-level access: Slot.read' patient/Slot.rus: 'Patient-level access: Slot.rus' patient/Slot.write: 'Patient-level access: Slot.write' patient/Specimen.read: 'Patient-level access: Specimen.read' patient/Specimen.rs: 'Patient-level access: Specimen.rs' profile: 'SMART on FHIR scope: profile' user/Account.read: 'User-level access: Account.read' user/Account.rs: 'User-level access: Account.rs' user/AllergyIntolerance.crus: 'User-level access: AllergyIntolerance.crus' user/AllergyIntolerance.read: 'User-level access: AllergyIntolerance.read' user/AllergyIntolerance.write: 'User-level access: AllergyIntolerance.write' user/Appointment.crus: 'User-level access: Appointment.crus' user/Appointment.read: 'User-level access: Appointment.read' user/Appointment.write: 'User-level access: Appointment.write' user/Basic.c: 'User-level access: Basic.c' user/Basic.write: 'User-level access: Basic.write' user/Binary.r: 'User-level access: Binary.r' user/Binary.read: 'User-level access: Binary.read' user/CarePlan.read: 'User-level access: CarePlan.read' user/CarePlan.rs: 'User-level access: CarePlan.rs' user/CareTeam.read: 'User-level access: CareTeam.read' user/CareTeam.rs: 'User-level access: CareTeam.rs' user/ChargeItem.crs: 'User-level access: ChargeItem.crs' user/ChargeItem.read: 'User-level access: ChargeItem.read' user/ChargeItem.write: 'User-level access: ChargeItem.write' user/Communication.crus: 'User-level access: Communication.crus' user/Communication.read: 'User-level access: Communication.read' user/Communication.write: 'User-level access: Communication.write' user/Condition.crus: 'User-level access: Condition.crus' user/Condition.read: 'User-level access: Condition.read' user/Condition.write: 'User-level access: Condition.write' user/Consent.read: 'User-level access: Consent.read' user/Consent.rs: 'User-level access: Consent.rs' user/Coverage.cruds: 'User-level access: Coverage.cruds' user/Coverage.read: 'User-level access: Coverage.read' user/Coverage.write: 'User-level access: Coverage.write' user/Device.read: 'User-level access: Device.read' user/Device.rs: 'User-level access: Device.rs' user/DiagnosticReport.crs: 'User-level access: DiagnosticReport.crs' user/DiagnosticReport.read: 'User-level access: DiagnosticReport.read' user/DiagnosticReport.write: 'User-level access: DiagnosticReport.write' user/DocumentReference.crus: 'User-level access: DocumentReference.crus' user/DocumentReference.read: 'User-level access: DocumentReference.read' user/DocumentReference.write: 'User-level access: DocumentReference.write' user/Encounter.crus: 'User-level access: Encounter.crus' user/Encounter.read: 'User-level access: Encounter.read' user/Encounter.write: 'User-level access: Encounter.write' user/FamilyMemberHistory.crus: 'User-level access: FamilyMemberHistory.crus' user/FamilyMemberHistory.read: 'User-level access: FamilyMemberHistory.read' user/FamilyMemberHistory.write: 'User-level access: FamilyMemberHistory.write' user/Goal.read: 'User-level access: Goal.read' user/Goal.rs: 'User-level access: Goal.rs' user/Immunization.crus: 'User-level access: Immunization.crus' user/Immunization.read: 'User-level access: Immunization.read' user/Immunization.write: 'User-level access: Immunization.write' user/InsurancePlan.read: 'User-level access: InsurancePlan.read' user/InsurancePlan.rs: 'User-level access: InsurancePlan.rs' user/Location.read: 'User-level access: Location.read' user/Location.rs: 'User-level access: Location.rs' user/Media.r: 'User-level access: Media.r' user/Media.read: 'User-level access: Media.read' user/MedicationAdministration.read: 'User-level access: MedicationAdministration.read' user/MedicationAdministration.rs: 'User-level access: MedicationAdministration.rs' user/MedicationDispense.read: 'User-level access: MedicationDispense.read' user/MedicationDispense.rs: 'User-level access: MedicationDispense.rs' user/MedicationRequest.crus: 'User-level access: MedicationRequest.crus' user/MedicationRequest.read: 'User-level access: MedicationRequest.read' user/MedicationRequest.write: 'User-level access: MedicationRequest.write' user/NutritionOrder.read: 'User-level access: NutritionOrder.read' user/NutritionOrder.rs: 'User-level access: NutritionOrder.rs' user/Observation.crus: 'User-level access: Observation.crus' user/Observation.read: 'User-level access: Observation.read' user/Observation.write: 'User-level access: Observation.write' user/Organization.crs: 'User-level access: Organization.crs' user/Organization.read: 'User-level access: Organization.read' user/Organization.write: 'User-level access: Organization.write' user/Patient.crus: 'User-level access: Patient.crus' user/Patient.read: 'User-level access: Patient.read' user/Patient.write: 'User-level access: Patient.write' user/Person.read: 'User-level access: Person.read' user/Person.rs: 'User-level access: Person.rs' user/Practitioner.crs: 'User-level access: Practitioner.crs' user/Practitioner.read: 'User-level access: Practitioner.read' user/Practitioner.write: 'User-level access: Practitioner.write' user/Procedure.crs: 'User-level access: Procedure.crs' user/Procedure.read: 'User-level access: Procedure.read' user/Procedure.write: 'User-level access: Procedure.write' user/Provenance.crs: 'User-level access: Provenance.crs' user/Provenance.read: 'User-level access: Provenance.read' user/Provenance.write: 'User-level access: Provenance.write' user/Questionnaire.read: 'User-level access: Questionnaire.read' user/Questionnaire.rs: 'User-level access: Questionnaire.rs' user/QuestionnaireResponse.read: 'User-level access: QuestionnaireResponse.read' user/QuestionnaireResponse.rus: 'User-level access: QuestionnaireResponse.rus' user/QuestionnaireResponse.write: 'User-level access: QuestionnaireResponse.write' user/RelatedPerson.crus: 'User-level access: RelatedPerson.crus' user/RelatedPerson.read: 'User-level access: RelatedPerson.read' user/RelatedPerson.write: 'User-level access: RelatedPerson.write' user/Schedule.read: 'User-level access: Schedule.read' user/Schedule.rs: 'User-level access: Schedule.rs' user/ServiceRequest.read: 'User-level access: ServiceRequest.read' user/ServiceRequest.rs: 'User-level access: ServiceRequest.rs' user/Slot.read: 'User-level access: Slot.read' user/Slot.rus: 'User-level access: Slot.rus' user/Slot.write: 'User-level access: Slot.write' user/Specimen.read: 'User-level access: Specimen.read' user/Specimen.rs: 'User-level access: Specimen.rs' clientCredentials: tokenUrl: https://authorization.cerner.com/tenants/{tenant}/hosts/fhir-ehr-code.cerner.com/protocols/oauth2/profiles/smart-v1/token scopes: system/Account.read: 'System-level access: Account.read' system/Account.rs: 'System-level access: Account.rs' system/AllergyIntolerance.crus: 'System-level access: AllergyIntolerance.crus' system/AllergyIntolerance.read: 'System-level access: AllergyIntolerance.read' system/AllergyIntolerance.write: 'System-level access: AllergyIntolerance.write' system/Appointment.crus: 'System-level access: Appointment.crus' system/Appointment.read: 'System-level access: Appointment.read' system/Appointment.write: 'System-level access: Appointment.write' system/Basic.c: 'System-level access: Basic.c' system/Basic.write: 'System-level access: Basic.write' system/Binary.r: 'System-level access: Binary.r' system/Binary.read: 'System-level access: Binary.read' system/CarePlan.read: 'System-level access: CarePlan.read' system/CarePlan.rs: 'System-level access: CarePlan.rs' system/CareTeam.read: 'System-level access: CareTeam.read' system/CareTeam.rs: 'System-level access: CareTeam.rs' system/ChargeItem.crs: 'System-level access: ChargeItem.crs' system/ChargeItem.read: 'System-level access: ChargeItem.read' system/ChargeItem.write: 'System-level access: ChargeItem.write' system/Communication.crus: 'System-level access: Communication.crus' system/Communication.read: 'System-level access: Communication.read' system/Communication.write: 'System-level access: Communication.write' system/Condition.crus: 'System-level access: Condition.crus' system/Condition.read: 'System-level access: Condition.read' system/Condition.write: 'System-level access: Condition.write' system/Consent.read: 'System-level access: Consent.read' system/Consent.rs: 'System-level access: Consent.rs' system/Coverage.cruds: 'System-level access: Coverage.cruds' system/Coverage.read: 'System-level access: Coverage.read' system/Coverage.write: 'System-level access: Coverage.write' system/Device.read: 'System-level access: Device.read' system/Device.rs: 'System-level access: Device.rs' system/DiagnosticReport.crs: 'System-level access: DiagnosticReport.crs' system/DiagnosticReport.read: 'System-level access: DiagnosticReport.read' system/DiagnosticReport.write: 'System-level access: DiagnosticReport.write' system/DocumentReference.crus: 'System-level access: DocumentReference.crus' system/DocumentReference.read: 'System-level access: DocumentReference.read' system/DocumentReference.write: 'System-level access: DocumentReference.write' system/Encounter.crus: 'System-level access: Encounter.crus' system/Encounter.read: 'System-level access: Encounter.read' system/Encounter.write: 'System-level access: Encounter.write' system/FamilyMemberHistory.crus: 'System-level access: FamilyMemberHistory.crus' system/FamilyMemberHistory.read: 'System-level access: FamilyMemberHistory.read' system/FamilyMemberHistory.write: 'System-level access: FamilyMemberHistory.write' system/FinancialTransaction.c: 'System-level access: FinancialTransaction.c' system/FinancialTransaction.write: 'System-level access: FinancialTransaction.write' system/Goal.read: 'System-level access: Goal.read' system/Goal.rs: 'System-level access: Goal.rs' system/Immunization.crus: 'System-level access: Immunization.crus' system/Immunization.read: 'System-level access: Immunization.read' system/Immunization.write: 'System-level access: Immunization.write' system/InsurancePlan.read: 'System-level access: InsurancePlan.read' system/InsurancePlan.rs: 'System-level access: InsurancePlan.rs' system/Location.read: 'System-level access: Location.read' system/Location.rs: 'System-level access: Location.rs' system/Media.r: 'System-level access: Media.r' system/Media.read: 'System-level access: Media.read' system/MedicationAdministration.read: 'System-level access: MedicationAdministration.read' system/MedicationAdministration.rs: 'System-level access: MedicationAdministration.rs' system/MedicationDispense.read: 'System-level access: MedicationDispense.read' system/MedicationDispense.rs: 'System-level access: MedicationDispense.rs' system/MedicationRequest.crus: 'System-level access: MedicationRequest.crus' system/MedicationRequest.read: 'System-level access: MedicationRequest.read' system/MedicationRequest.write: 'System-level access: MedicationRequest.write' system/NutritionOrder.read: 'System-level access: NutritionOrder.read' system/NutritionOrder.rs: 'System-level access: NutritionOrder.rs' system/Observation.crus: 'System-level access: Observation.crus' system/Observation.read: 'System-level access: Observation.read' system/Observation.write: 'System-level access: Observation.write' system/Organization.crs: 'System-level access: Organization.crs' system/Organization.read: 'System-level access: Organization.read' system/Organization.write: 'System-level access: Organization.write' system/Patient.crus: 'System-level access: Patient.crus' system/Patient.read: 'System-level access: Patient.read' system/Patient.write: 'System-level access: Patient.write' system/Person.read: 'System-level access: Person.read' system/Person.rs: 'System-level access: Person.rs' system/Practitioner.crs: 'System-level access: Practitioner.crs' system/Practitioner.read: 'System-level access: Practitioner.read' system/Practitioner.write: 'System-level access: Practitioner.write' system/Procedure.crs: 'System-level access: Procedure.crs' system/Procedure.read: 'System-level access: Procedure.read' system/Procedure.write: 'System-level access: Procedure.write' system/Provenance.crs: 'System-level access: Provenance.crs' system/Provenance.read: 'System-level access: Provenance.read' system/Provenance.write: 'System-level access: Provenance.write' system/Questionnaire.read: 'System-level access: Questionnaire.read' system/Questionnaire.rs: 'System-level access: Questionnaire.rs' system/QuestionnaireResponse.read: 'System-level access: QuestionnaireResponse.read' system/QuestionnaireResponse.rus: 'System-level access: QuestionnaireResponse.rus' system/QuestionnaireResponse.write: 'System-level access: QuestionnaireResponse.write' system/RelatedPerson.crus: 'System-level access: RelatedPerson.crus' system/RelatedPerson.read: 'System-level access: RelatedPerson.read' system/RelatedPerson.write: 'System-level access: RelatedPerson.write' system/Schedule.read: 'System-level access: Schedule.read' system/Schedule.rs: 'System-level access: Schedule.rs' system/ServiceRequest.read: 'System-level access: ServiceRequest.read' system/ServiceRequest.rs: 'System-level access: ServiceRequest.rs' system/Slot.read: 'System-level access: Slot.read' system/Slot.rus: 'System-level access: Slot.rus' system/Slot.write: 'System-level access: Slot.write' system/Specimen.read: 'System-level access: Specimen.read' system/Specimen.rs: 'System-level access: Specimen.rs' schemas: Resource: type: object description: A FHIR R4 resource. The wire format is `application/fhir+json`; element-level schemas are defined by HL7 FHIR R4 (4.0.1), not by this document. properties: resourceType: type: string id: type: string meta: type: object additionalProperties: true required: - resourceType additionalProperties: true Bundle: type: object description: 'A FHIR R4 Bundle. Search results are returned as `type: searchset`; paging is carried on `link[relation=next]`.' properties: resourceType: const: Bundle type: type: string total: type: integer link: type: array items: type: object properties: relation: type: string examples: - self - next - previous url: type: string format: uri entry: type: array items: type: object additionalProperties: true required: - resourceType - type additionalProperties: true OperationOutcome: type: object description: FHIR R4 OperationOutcome — the error envelope for every non-2xx response. properties: resourceType: const: OperationOutcome issue: type: array items: type: object properties: severity: type: string examples: - fatal - error - warning - information code: type: string examples: - required - business-rule - extension - not-supported location: type: array items: type: string diagnostics: type: string required: - resourceType - issue additionalProperties: true responses: Error400: description: Bad Request — a required search parameter was omitted. The server responds "No supported search parameters provided". content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' Error401: description: Unauthorized — no valid credentials were supplied to a secure endpoint. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' Error403: description: Forbidden — unknown instance or the caller is not authorized for this tenant ("Tenant not valid or accessible"). content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' Error404: description: Not Found — the resource does not exist. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' Error406: description: 'Not Acceptable — a non-JSON media type was requested. Returned with `Content-Length: 0`.' Error409: description: Conflict — an update was attempted against an out-of-date version. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' Error422: description: Unprocessable Entity — syntactically valid JSON that violates a business rule, carries unsupported fields, modifier extensions, or implicit rules. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' Error500: description: Internal Server Error — including a response that is missing a field FHIR requires (OperationOutcome severity `fatal`, code `required`). content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome'