openapi: 3.0.1
info:
  title: ESH FHIR Server
  contact: {}
  version: "1.0"
servers:
- url: https://portal.escribe.com/ehr/api/fhir
  description: ESH FHIR Server
tags:
- name: System Level Operations
  description: Server-level operations
- name: AllergyIntolerance
  description: "The AllergyIntolerance FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/AllergyIntolerance<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
- name: CarePlan
  description: "The CarePlan FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/CarePlan<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
- name: CareTeam
  description: "The CareTeam FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/CareTeam<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
- name: Condition
  description: "The Condition FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Condition<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
- name: Device
  description: "The Device FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Device<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
- name: DiagnosticReport
  description: "The DiagnosticReport FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/DiagnosticReport<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
- name: DocumentReference
  description: "The DocumentReference FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/DocumentReference<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
- name: Encounter
  description: "The Encounter FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Encounter<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
- name: Endpoint
  description: "The Endpoint FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Endpoint<br/>Supported\
    \ profile: http://hl7.org/fhir/StructureDefinition/Endpoint"
- name: Goal
  description: "The Goal FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Goal<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
- name: Group
  description: "The Group FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Group<br/>Supported\
    \ profile: http://hl7.org/fhir/StructureDefinition/groupdefinition"
- name: Immunization
  description: "The Immunization FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Immunization<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
- name: Location
  description: "The Location FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Location<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
- name: Medication
  description: "The Medication FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Medication<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"
- name: MedicationRequest
  description: "The MedicationRequest FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/MedicationRequest<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
- name: Observation
  description: "The Observation FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Observation<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab<br/>Supported\
    \ profile: http://hl7.org/fhir/StructureDefinition/bodytemp<br/>Supported profile:\
    \ http://hl7.org/fhir/StructureDefinition/bodyheight<br/>Supported profile: http://hl7.org/fhir/StructureDefinition/bodyweight<br/>Supported\
    \ profile: http://hl7.org/fhir/StructureDefinition/bp<br/>Supported profile: http://hl7.org/fhir/StructureDefinition/heartrate<br/>Supported\
    \ profile: http://hl7.org/fhir/StructureDefinition/resprate"
- name: OperationDefinition
  description: "The OperationDefinition FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/OperationDefinition"
- name: Organization
  description: "The Organization FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Organization<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
- name: Patient
  description: "The Patient FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Patient<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
- name: Practitioner
  description: "The Practitioner FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Practitioner<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
- name: PractitionerRole
  description: "The PractitionerRole FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/PractitionerRole<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
- name: Procedure
  description: "The Procedure FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Procedure<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
- name: Provenance
  description: "The Provenance FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Provenance<br/>Supported\
    \ profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
paths:
  /metadata:
    get:
      tags:
      - System Level Operations
      summary: "server-capabilities: Fetch the server FHIR CapabilityStatement"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
              example: |-
                {
                  "resourceType": "CapabilityStatement"
                }
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
              example: <CapabilityStatement xmlns="http://hl7.org/fhir"></CapabilityStatement>
  /$pause-job:
    get:
      tags:
      - System Level Operations
      summary: "GET: /$pause-job"
      parameters:
      - name: _jobId
        in: query
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
    post:
      tags:
      - System Level Operations
      summary: "POST: /$pause-job"
      requestBody:
        content:
          application/fhir+json:
            schema:
              title: FHIR Resource
              type: object
            example: |-
              {
                "resourceType": "Parameters",
                "parameter": [ {
                  "name": "_jobId"
                } ]
              }
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /$export-poll-status:
    get:
      tags:
      - System Level Operations
      summary: "GET: /$export-poll-status"
      parameters:
      - name: _jobId
        in: query
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
    post:
      tags:
      - System Level Operations
      summary: "POST: /$export-poll-status"
      requestBody:
        content:
          application/fhir+json:
            schema:
              title: FHIR Resource
              type: object
            example: |-
              {
                "resourceType": "Parameters",
                "parameter": [ {
                  "name": "_jobId",
                  "valueString": "example"
                } ]
              }
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /$export:
    get:
      tags:
      - System Level Operations
      summary: "GET: /$export"
      parameters:
      - name: _outputFormat
        in: query
        required: false
        schema:
          type: string
      - name: _type
        in: query
        required: false
        schema:
          type: string
      - name: _since
        in: query
        required: false
        schema:
          type: string
      - name: _typeFilter
        in: query
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
    post:
      tags:
      - System Level Operations
      summary: "POST: /$export"
      requestBody:
        content:
          application/fhir+json:
            schema:
              title: FHIR Resource
              type: object
            example: |-
              {
                "resourceType": "Parameters",
                "parameter": [ {
                  "name": "_outputFormat",
                  "valueString": "example"
                }, {
                  "name": "_type",
                  "valueString": "example"
                }, {
                  "name": "_since"
                }, {
                  "name": "_typeFilter",
                  "valueString": "example"
                } ]
              }
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /$download-resource:
    get:
      tags:
      - System Level Operations
      summary: "GET: /$download-resource"
      parameters:
      - name: _jobResourceId
        in: query
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
    post:
      tags:
      - System Level Operations
      summary: "POST: /$download-resource"
      requestBody:
        content:
          application/fhir+json:
            schema:
              title: FHIR Resource
              type: object
            example: |-
              {
                "resourceType": "Parameters",
                "parameter": [ {
                  "name": "_jobResourceId",
                  "valueString": "example"
                } ]
              }
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /AllergyIntolerance/{id}:
    get:
      tags:
      - AllergyIntolerance
      summary: "read-instance: Read AllergyIntolerance instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /AllergyIntolerance:
    get:
      tags:
      - AllergyIntolerance
      summary: "search-type: Search for AllergyIntolerance instances"
      description: This is a search type
      parameters:
      - name: clinical-status
        in: query
        description: active | inactive | resolved
        required: false
        schema:
          type: string
      - name: patient
        in: query
        description: Who the sensitivity is for
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /AllergyIntolerance/_search:
    get:
      tags:
      - AllergyIntolerance
      summary: "search-type: Search for AllergyIntolerance instances"
      description: This is a search type
      parameters:
      - name: clinical-status
        in: query
        description: active | inactive | resolved
        required: false
        schema:
          type: string
      - name: patient
        in: query
        description: Who the sensitivity is for
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /CarePlan/{id}:
    get:
      tags:
      - CarePlan
      summary: "read-instance: Read CarePlan instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /CarePlan:
    get:
      tags:
      - CarePlan
      summary: "search-type: Search for CarePlan instances"
      description: This is a search type
      parameters:
      - name: category
        in: query
        description: Type of plan
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Time period plan covers
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: Who the care plan is for
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: draft | active | on-hold | revoked | completed | entered-in-error
          | unknown
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /CarePlan/_search:
    get:
      tags:
      - CarePlan
      summary: "search-type: Search for CarePlan instances"
      description: This is a search type
      parameters:
      - name: category
        in: query
        description: Type of plan
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Time period plan covers
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: Who the care plan is for
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: draft | active | on-hold | revoked | completed | entered-in-error
          | unknown
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /CareTeam/{id}:
    get:
      tags:
      - CareTeam
      summary: "read-instance: Read CareTeam instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /CareTeam:
    get:
      tags:
      - CareTeam
      summary: "search-type: Search for CareTeam instances"
      description: This is a search type
      parameters:
      - name: patient
        in: query
        description: Who care team is for
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: proposed | active | suspended | inactive | entered-in-error
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /CareTeam/_search:
    get:
      tags:
      - CareTeam
      summary: "search-type: Search for CareTeam instances"
      description: This is a search type
      parameters:
      - name: patient
        in: query
        description: Who care team is for
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: proposed | active | suspended | inactive | entered-in-error
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Condition/{id}:
    get:
      tags:
      - Condition
      summary: "read-instance: Read Condition instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Condition:
    get:
      tags:
      - Condition
      summary: "search-type: Search for Condition instances"
      description: This is a search type
      parameters:
      - name: category
        in: query
        description: The category of the condition
        required: false
        schema:
          type: string
      - name: clinical-status
        in: query
        description: The clinical status of the condition
        required: false
        schema:
          type: string
      - name: code
        in: query
        description: Code for the condition
        required: false
        schema:
          type: string
      - name: onset-date
        in: query
        description: Date related onsets (dateTime and Period)
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: Who has the condition?
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Condition/_search:
    get:
      tags:
      - Condition
      summary: "search-type: Search for Condition instances"
      description: This is a search type
      parameters:
      - name: category
        in: query
        description: The category of the condition
        required: false
        schema:
          type: string
      - name: clinical-status
        in: query
        description: The clinical status of the condition
        required: false
        schema:
          type: string
      - name: code
        in: query
        description: Code for the condition
        required: false
        schema:
          type: string
      - name: onset-date
        in: query
        description: Date related onsets (dateTime and Period)
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: Who has the condition?
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Device/{id}:
    get:
      tags:
      - Device
      summary: "read-instance: Read Device instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Device:
    get:
      tags:
      - Device
      summary: "search-type: Search for Device instances"
      description: This is a search type
      parameters:
      - name: patient
        in: query
        description: "Patient information, if the resource is affixed to a person"
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: The type of the device
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Device/_search:
    get:
      tags:
      - Device
      summary: "search-type: Search for Device instances"
      description: This is a search type
      parameters:
      - name: patient
        in: query
        description: "Patient information, if the resource is affixed to a person"
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: The type of the device
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /DiagnosticReport/{id}:
    get:
      tags:
      - DiagnosticReport
      summary: "read-instance: Read DiagnosticReport instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /DiagnosticReport:
    get:
      tags:
      - DiagnosticReport
      summary: "search-type: Search for DiagnosticReport instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: category
        in: query
        description: Which diagnostic discipline/department created the report
        required: false
        schema:
          type: string
      - name: code
        in: query
        description: "The code for the report, as opposed to codes for the atomic\
          \ results, which are the names on the observation resource referred to from\
          \ the result"
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: The clinically relevant time of the report
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: The subject of the report if a patient
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: The status of the report
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /DiagnosticReport/_search:
    get:
      tags:
      - DiagnosticReport
      summary: "search-type: Search for DiagnosticReport instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: category
        in: query
        description: Which diagnostic discipline/department created the report
        required: false
        schema:
          type: string
      - name: code
        in: query
        description: "The code for the report, as opposed to codes for the atomic\
          \ results, which are the names on the observation resource referred to from\
          \ the result"
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: The clinically relevant time of the report
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: The subject of the report if a patient
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: The status of the report
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /DocumentReference/{id}:
    get:
      tags:
      - DocumentReference
      summary: "read-instance: Read DocumentReference instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /DocumentReference:
    get:
      tags:
      - DocumentReference
      summary: "search-type: Search for DocumentReference instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: category
        in: query
        description: Categorization of document
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: When this document reference was created
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: Who/what is the subject of the document
        required: false
        schema:
          type: string
      - name: period
        in: query
        description: Time of service that is being documented
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: status
        in: query
        description: current | superseded | entered-in-error
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Kind of document (LOINC if possible)
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /DocumentReference/_search:
    get:
      tags:
      - DocumentReference
      summary: "search-type: Search for DocumentReference instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: category
        in: query
        description: Categorization of document
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: When this document reference was created
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: Who/what is the subject of the document
        required: false
        schema:
          type: string
      - name: period
        in: query
        description: Time of service that is being documented
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: status
        in: query
        description: current | superseded | entered-in-error
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Kind of document (LOINC if possible)
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Encounter/{id}:
    get:
      tags:
      - Encounter
      summary: "read-instance: Read Encounter instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Encounter:
    get:
      tags:
      - Encounter
      summary: "search-type: Search for Encounter instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: class
        in: query
        description: Classification of patient encounter
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: A date within the period the Encounter lasted
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: identifier
        in: query
        description: Identifier(s) by which this encounter is known
        required: false
        schema:
          type: string
      - name: patient
        in: query
        description: The patient or group present at the encounter
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: planned | arrived | triaged | in-progress | onleave | finished
          | cancelled +
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Specific type of encounter
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Encounter/_search:
    get:
      tags:
      - Encounter
      summary: "search-type: Search for Encounter instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: class
        in: query
        description: Classification of patient encounter
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: A date within the period the Encounter lasted
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: identifier
        in: query
        description: Identifier(s) by which this encounter is known
        required: false
        schema:
          type: string
      - name: patient
        in: query
        description: The patient or group present at the encounter
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: planned | arrived | triaged | in-progress | onleave | finished
          | cancelled +
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Specific type of encounter
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Endpoint:
    get:
      tags:
      - Endpoint
      summary: "search-type: Search for Endpoint instances"
      description: This is a search type
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Endpoint/_search:
    get:
      tags:
      - Endpoint
      summary: "search-type: Search for Endpoint instances"
      description: This is a search type
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Goal/{id}:
    get:
      tags:
      - Goal
      summary: "read-instance: Read Goal instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Goal:
    get:
      tags:
      - Goal
      summary: "search-type: Search for Goal instances"
      description: This is a search type
      parameters:
      - name: lifecycle-status
        in: query
        description: proposed | planned | accepted | active | on-hold | completed
          | cancelled | entered-in-error | rejected
        required: false
        schema:
          type: string
      - name: patient
        in: query
        description: Who this goal is intended for
        required: false
        schema:
          type: string
      - name: target-date
        in: query
        description: Reach goal on or before
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Goal/_search:
    get:
      tags:
      - Goal
      summary: "search-type: Search for Goal instances"
      description: This is a search type
      parameters:
      - name: lifecycle-status
        in: query
        description: proposed | planned | accepted | active | on-hold | completed
          | cancelled | entered-in-error | rejected
        required: false
        schema:
          type: string
      - name: patient
        in: query
        description: Who this goal is intended for
        required: false
        schema:
          type: string
      - name: target-date
        in: query
        description: Reach goal on or before
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Group/{id}:
    get:
      tags:
      - Group
      summary: "read-instance: Read Group instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Group:
    get:
      tags:
      - Group
      summary: "search-type: Search for Group instances"
      description: This is a search type
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Group/_search:
    get:
      tags:
      - Group
      summary: "search-type: Search for Group instances"
      description: This is a search type
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Group/$export:
    get:
      tags:
      - Group
      summary: "GET: /Group/$export"
      parameters:
      - name: _outputFormat
        in: query
        required: false
        schema:
          type: string
      - name: _type
        in: query
        required: false
        schema:
          type: string
      - name: _since
        in: query
        required: false
        schema:
          type: string
      - name: _typeFilter
        in: query
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
    post:
      tags:
      - Group
      summary: "POST: /Group/$export"
      requestBody:
        content:
          application/fhir+json:
            schema:
              title: FHIR Resource
              type: object
            example: |-
              {
                "resourceType": "Parameters",
                "parameter": [ {
                  "name": "_outputFormat",
                  "valueString": "example"
                }, {
                  "name": "_type",
                  "valueString": "example"
                }, {
                  "name": "_since"
                }, {
                  "name": "_typeFilter",
                  "valueString": "example"
                } ]
              }
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Group/{id}/$export:
    get:
      tags:
      - Group
      summary: "GET: /Group/{id}/$export"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      - name: _outputFormat
        in: query
        required: false
        schema:
          type: string
      - name: _type
        in: query
        required: false
        schema:
          type: string
      - name: _since
        in: query
        required: false
        schema:
          type: string
      - name: _typeFilter
        in: query
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
    post:
      tags:
      - Group
      summary: "POST: /Group/{id}/$export"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      requestBody:
        content:
          application/fhir+json:
            schema:
              title: FHIR Resource
              type: object
            example: |-
              {
                "resourceType": "Parameters",
                "parameter": [ {
                  "name": "_outputFormat",
                  "valueString": "example"
                }, {
                  "name": "_type",
                  "valueString": "example"
                }, {
                  "name": "_since"
                }, {
                  "name": "_typeFilter",
                  "valueString": "example"
                } ]
              }
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Immunization/{id}:
    get:
      tags:
      - Immunization
      summary: "read-instance: Read Immunization instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Immunization:
    get:
      tags:
      - Immunization
      summary: "search-type: Search for Immunization instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Vaccination  (non)-Administration Date
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: The patient for the vaccination record
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: Immunization event status
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Immunization/_search:
    get:
      tags:
      - Immunization
      summary: "search-type: Search for Immunization instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Vaccination  (non)-Administration Date
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: The patient for the vaccination record
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: Immunization event status
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Location/{id}:
    get:
      tags:
      - Location
      summary: "read-instance: Read Location instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Location:
    get:
      tags:
      - Location
      summary: "search-type: Search for Location instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: address
        in: query
        description: A (part of the) address of the location
        required: false
        schema:
          type: string
      - name: address-city
        in: query
        description: A city specified in an address
        required: false
        schema:
          type: string
      - name: address-postalcode
        in: query
        description: A postal code specified in an address
        required: false
        schema:
          type: string
      - name: address-state
        in: query
        description: A state specified in an address
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: A portion of the location's name or alias
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Location/_search:
    get:
      tags:
      - Location
      summary: "search-type: Search for Location instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: address
        in: query
        description: A (part of the) address of the location
        required: false
        schema:
          type: string
      - name: address-city
        in: query
        description: A city specified in an address
        required: false
        schema:
          type: string
      - name: address-postalcode
        in: query
        description: A postal code specified in an address
        required: false
        schema:
          type: string
      - name: address-state
        in: query
        description: A state specified in an address
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: A portion of the location's name or alias
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Medication/{id}:
    get:
      tags:
      - Medication
      summary: "read-instance: Read Medication instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Medication:
    get:
      tags:
      - Medication
      summary: "search-type: Search for Medication instances"
      description: This is a search type
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Medication/_search:
    get:
      tags:
      - Medication
      summary: "search-type: Search for Medication instances"
      description: This is a search type
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /MedicationRequest/{id}:
    get:
      tags:
      - MedicationRequest
      summary: "read-instance: Read MedicationRequest instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /MedicationRequest:
    get:
      tags:
      - MedicationRequest
      summary: "search-type: Search for MedicationRequest instances"
      description: This is a search type
      parameters:
      - name: authoredon
        in: query
        description: Return prescriptions written on this date
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: encounter
        in: query
        description: Return prescriptions with this encounter identifier
        required: false
        schema:
          type: string
      - name: intent
        in: query
        description: Returns prescriptions with different intents
        required: false
        schema:
          type: string
      - name: patient
        in: query
        description: Returns prescriptions for a specific patient
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: Status of the prescription
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /MedicationRequest/_search:
    get:
      tags:
      - MedicationRequest
      summary: "search-type: Search for MedicationRequest instances"
      description: This is a search type
      parameters:
      - name: authoredon
        in: query
        description: Return prescriptions written on this date
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: encounter
        in: query
        description: Return prescriptions with this encounter identifier
        required: false
        schema:
          type: string
      - name: intent
        in: query
        description: Returns prescriptions with different intents
        required: false
        schema:
          type: string
      - name: patient
        in: query
        description: Returns prescriptions for a specific patient
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: Status of the prescription
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Observation/{id}:
    get:
      tags:
      - Observation
      summary: "read-instance: Read Observation instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Observation:
    get:
      tags:
      - Observation
      summary: "search-type: Search for Observation instances"
      description: This is a search type
      parameters:
      - name: category
        in: query
        description: The classification of the type of observation
        required: false
        schema:
          type: string
      - name: code
        in: query
        description: The code of the observation type
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: "Obtained date/time. If the obtained element is a period, a date\
          \ that falls in the period"
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: The subject that the observation is about (if patient)
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: The status of the observation
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Observation/_search:
    get:
      tags:
      - Observation
      summary: "search-type: Search for Observation instances"
      description: This is a search type
      parameters:
      - name: category
        in: query
        description: The classification of the type of observation
        required: false
        schema:
          type: string
      - name: code
        in: query
        description: The code of the observation type
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: "Obtained date/time. If the obtained element is a period, a date\
          \ that falls in the period"
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: The subject that the observation is about (if patient)
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: The status of the observation
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /OperationDefinition/{id}:
    get:
      tags:
      - OperationDefinition
      summary: "read-instance: Read OperationDefinition instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Organization/{id}:
    get:
      tags:
      - Organization
      summary: "read-instance: Read Organization instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Organization:
    get:
      tags:
      - Organization
      summary: "search-type: Search for Organization instances"
      description: This is a search type
      parameters:
      - name: address
        in: query
        description: "A server defined search that may match any of the string fields\
          \ in the Address, including line, city, district, state, country, postalCode,\
          \ and/or text"
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: A portion of the organization's name or alias
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Organization/_search:
    get:
      tags:
      - Organization
      summary: "search-type: Search for Organization instances"
      description: This is a search type
      parameters:
      - name: address
        in: query
        description: "A server defined search that may match any of the string fields\
          \ in the Address, including line, city, district, state, country, postalCode,\
          \ and/or text"
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: A portion of the organization's name or alias
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Patient/{id}:
    get:
      tags:
      - Patient
      summary: "read-instance: Read Patient instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Patient:
    get:
      tags:
      - Patient
      summary: "search-type: Search for Patient instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: birthdate
        in: query
        description: The patient's date of birth
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: family
        in: query
        description: A portion of the family name of the patient
        required: false
        schema:
          type: string
      - name: gender
        in: query
        description: Gender of the patient
        required: false
        schema:
          type: string
      - name: given
        in: query
        description: A portion of the given name of the patient
        required: false
        schema:
          type: string
      - name: identifier
        in: query
        description: A patient identifier
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: "A server defined search that may match any of the string fields\
          \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
          \ text"
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Patient/_search:
    get:
      tags:
      - Patient
      summary: "search-type: Search for Patient instances"
      description: This is a search type
      parameters:
      - name: _id
        in: query
        description: The ID of the resource
        required: false
        schema:
          type: string
      - name: birthdate
        in: query
        description: The patient's date of birth
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: family
        in: query
        description: A portion of the family name of the patient
        required: false
        schema:
          type: string
      - name: gender
        in: query
        description: Gender of the patient
        required: false
        schema:
          type: string
      - name: given
        in: query
        description: A portion of the given name of the patient
        required: false
        schema:
          type: string
      - name: identifier
        in: query
        description: A patient identifier
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: "A server defined search that may match any of the string fields\
          \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
          \ text"
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Patient/$export:
    get:
      tags:
      - Patient
      summary: "GET: /Patient/$export"
      parameters:
      - name: _outputFormat
        in: query
        required: false
        schema:
          type: string
      - name: _type
        in: query
        required: false
        schema:
          type: string
      - name: _since
        in: query
        required: false
        schema:
          type: string
      - name: _typeFilter
        in: query
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
    post:
      tags:
      - Patient
      summary: "POST: /Patient/$export"
      requestBody:
        content:
          application/fhir+json:
            schema:
              title: FHIR Resource
              type: object
            example: |-
              {
                "resourceType": "Parameters",
                "parameter": [ {
                  "name": "_outputFormat",
                  "valueString": "example"
                }, {
                  "name": "_type",
                  "valueString": "example"
                }, {
                  "name": "_since"
                }, {
                  "name": "_typeFilter",
                  "valueString": "example"
                } ]
              }
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Patient/{id}/$export:
    get:
      tags:
      - Patient
      summary: "GET: /Patient/{id}/$export"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      - name: _outputFormat
        in: query
        required: false
        schema:
          type: string
      - name: _type
        in: query
        required: false
        schema:
          type: string
      - name: _since
        in: query
        required: false
        schema:
          type: string
      - name: _typeFilter
        in: query
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
    post:
      tags:
      - Patient
      summary: "POST: /Patient/{id}/$export"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      requestBody:
        content:
          application/fhir+json:
            schema:
              title: FHIR Resource
              type: object
            example: |-
              {
                "resourceType": "Parameters",
                "parameter": [ {
                  "name": "_outputFormat",
                  "valueString": "example"
                }, {
                  "name": "_type",
                  "valueString": "example"
                }, {
                  "name": "_since"
                }, {
                  "name": "_typeFilter",
                  "valueString": "example"
                } ]
              }
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Practitioner/{id}:
    get:
      tags:
      - Practitioner
      summary: "read-instance: Read Practitioner instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Practitioner:
    get:
      tags:
      - Practitioner
      summary: "search-type: Search for Practitioner instances"
      description: This is a search type
      parameters:
      - name: identifier
        in: query
        description: A practitioner's Identifier
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: "A server defined search that may match any of the string fields\
          \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
          \ text"
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Practitioner/_search:
    get:
      tags:
      - Practitioner
      summary: "search-type: Search for Practitioner instances"
      description: This is a search type
      parameters:
      - name: identifier
        in: query
        description: A practitioner's Identifier
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: "A server defined search that may match any of the string fields\
          \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
          \ text"
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /PractitionerRole/{id}:
    get:
      tags:
      - PractitionerRole
      summary: "read-instance: Read PractitionerRole instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /PractitionerRole:
    get:
      tags:
      - PractitionerRole
      summary: "search-type: Search for PractitionerRole instances"
      description: This is a search type
      parameters:
      - name: practitioner
        in: query
        description: Practitioner that is able to provide the defined services for
          the organization
        required: false
        schema:
          type: string
      - name: specialty
        in: query
        description: The practitioner has this specialty at an organization
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /PractitionerRole/_search:
    get:
      tags:
      - PractitionerRole
      summary: "search-type: Search for PractitionerRole instances"
      description: This is a search type
      parameters:
      - name: practitioner
        in: query
        description: Practitioner that is able to provide the defined services for
          the organization
        required: false
        schema:
          type: string
      - name: specialty
        in: query
        description: The practitioner has this specialty at an organization
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Procedure/{id}:
    get:
      tags:
      - Procedure
      summary: "read-instance: Read Procedure instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Procedure:
    get:
      tags:
      - Procedure
      summary: "search-type: Search for Procedure instances"
      description: This is a search type
      parameters:
      - name: code
        in: query
        description: A code to identify a  procedure
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: When the procedure was performed
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: Search by subject - a patient
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: preparation | in-progress | not-done | on-hold | stopped | completed
          | entered-in-error | unknown
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Procedure/_search:
    get:
      tags:
      - Procedure
      summary: "search-type: Search for Procedure instances"
      description: This is a search type
      parameters:
      - name: code
        in: query
        description: A code to identify a  procedure
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: When the procedure was performed
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: patient
        in: query
        description: Search by subject - a patient
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: preparation | in-progress | not-done | on-hold | stopped | completed
          | entered-in-error | unknown
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
  /Provenance/{id}:
    get:
      tags:
      - Provenance
      summary: "read-instance: Read Provenance instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FHIR-XML-RESOURCE'
components:
  schemas:
    FHIR-JSON-RESOURCE:
      type: object
      description: A FHIR resource
    FHIR-XML-RESOURCE:
      type: object
      description: A FHIR resource
