openapi: 3.0.1 info: title: AmeriHealth Caritas contact: {} version: 1.0.0 servers: - url: https://api-ext.amerihealthcaritas.com/6100/patient-api description: AmeriHealth Caritas security: - openId: - openid - fhirUser tags: - name: System Level Operations description: Server-level operations - name: AllergyIntolerance description: The AllergyIntolerance FHIR resource type - name: Claim description: The Claim FHIR resource type - name: Condition description: The Condition FHIR resource type - name: Coverage description: The Coverage FHIR resource type - name: Encounter description: The Encounter FHIR resource type - name: ExplanationOfBenefit description: The ExplanationOfBenefit FHIR resource type - name: HealthcareService description: The HealthcareService FHIR resource type - name: Immunization description: The Immunization FHIR resource type - name: InsurancePlan description: The InsurancePlan FHIR resource type - name: List description: The List FHIR resource type - name: Location description: The Location FHIR resource type - name: Medication description: The Medication FHIR resource type - name: MedicationDispense description: The MedicationDispense FHIR resource type - name: MedicationKnowledge description: The MedicationKnowledge FHIR resource type - name: MedicationRequest description: The MedicationRequest FHIR resource type - name: Observation description: The Observation FHIR resource type - name: Organization description: The Organization FHIR resource type - name: OrganizationAffiliation description: The OrganizationAffiliation FHIR resource type - name: Patient description: The Patient FHIR resource type - name: Practitioner description: The Practitioner FHIR resource type - name: PractitionerRole description: The PractitionerRole FHIR resource type - name: Procedure description: The Procedure FHIR resource type 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: /: post: tags: - System Level Operations summary: "server-transaction: Execute a FHIR Transaction (or FHIR Batch) Bundle" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /_history: get: tags: - System Level Operations summary: "server-history: Fetch the resource change history across all resource\ \ types on the server" 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' /$reindex: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "url", "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' /$submit-attachment: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters" } 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' /$diff: get: tags: - System Level Operations summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /$process-message: post: tags: - System Level Operations description: Accept a FHIR Message Bundle for processing requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "content" } ] } 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' /$perform-reindexing-pass: post: tags: - System Level Operations description: Forces a single pass of the resource reindexing processor requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "status" } ] } 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' /$meta: get: tags: - System Level Operations description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /$mark-all-resources-for-reindexing: post: tags: - System Level Operations description: "Marks all currently existing resources of a given type, or all\ \ resources of all types, for reindexing." requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "type", "valueCode": "example" }, { "name": "status" } ] } 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' /$get-resource-counts: get: tags: - System Level Operations summary: "Provides the number of resources currently stored on the server, broken\ \ down by resource type" description: "Provides the number of resources currently stored on the server,\ \ broken down by resource 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' /$expunge: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /$reindex-terminology: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters" } 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' /$graphql: get: tags: - System Level Operations description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' put: tags: - AllergyIntolerance summary: "update-instance: Update an existing AllergyIntolerance instance, or\ \ create using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "AllergyIntolerance" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - AllergyIntolerance summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - AllergyIntolerance summary: "instance-patch: Patch a resource instance of type AllergyIntolerance\ \ by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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}/_history/{version_id}: get: tags: - AllergyIntolerance summary: "vread-instance: Read AllergyIntolerance instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: date in: query description: Date first version of the resource instance was recorded style: simple - name: code in: query description: Code that identifies the allergy or intolerance style: simple - name: resource-placeholder in: query description: "Search for resources of type [AllergyIntolerance] populated\ \ with the resource-placeholder extension" style: simple - name: verification-status in: query description: unconfirmed | confirmed | refuted | entered-in-error style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: criticality in: query description: low | high | unable-to-assess style: simple - name: clinical-status in: query description: active | inactive | resolved style: simple - name: type in: query description: allergy | intolerance - Underlying mechanism (if known) style: simple - name: patient in: query description: Who the sensitivity is for style: simple - name: severity in: query description: mild | moderate | severe (of event as a whole) style: simple - name: identifier in: query description: External ids for this item style: simple - name: manifestation in: query description: Clinical symptoms/signs associated with the Event style: simple - name: recorder in: query description: Who recorded the sensitivity style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: onset in: query description: Date(/time) when manifestations showed style: simple - name: route in: query description: How the subject was exposed to the substance style: simple - name: asserter in: query description: Source of the information about the allergy style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: category in: query description: food | medication | environment | biologic style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: last-date in: query description: Date(/time) of last known occurrence of a reaction style: simple 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: - AllergyIntolerance summary: "create-type: Create a new AllergyIntolerance instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "AllergyIntolerance" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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/_history: get: tags: - AllergyIntolerance summary: "type-history: Fetch the resource change history for all resources\ \ of type AllergyIntolerance" 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}/_history: get: tags: - AllergyIntolerance summary: "instance-history: Fetch the resource change history for all resources\ \ of type AllergyIntolerance" 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/$validate: get: tags: - AllergyIntolerance parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - AllergyIntolerance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - AllergyIntolerance description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - AllergyIntolerance description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - AllergyIntolerance description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - AllergyIntolerance description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - AllergyIntolerance requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - AllergyIntolerance 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - AllergyIntolerance description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - AllergyIntolerance 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": "path", "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}/$binary-access-read: get: tags: - AllergyIntolerance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - AllergyIntolerance summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /Claim/{id}: get: tags: - Claim summary: "read-instance: Read Claim 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' put: tags: - Claim summary: "update-instance: Update an existing Claim instance, or create using\ \ a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Claim" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Claim summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Claim summary: "instance-patch: Patch a resource instance of type Claim by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Claim/{id}/_history/{version_id}: get: tags: - Claim summary: "vread-instance: Read Claim instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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' /Claim: get: tags: - Claim summary: "search-type: Search for Claim instances" description: This is a search type parameters: - name: care-team in: query description: Member of the CareTeam style: simple - name: use in: query description: The kind of financial resource style: simple - name: resource-placeholder in: query description: "Search for resources of type [Claim] populated with the resource-placeholder\ \ extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: payee in: query description: The party receiving any payment for the Claim style: simple - name: provider in: query description: Provider responsible for the Claim style: simple - name: patient in: query description: Patient receiving the products or services style: simple - name: insurer in: query description: The target payor/insurer for the Claim style: simple - name: detail-udi in: query description: "UDI associated with a line item, detail product or service" style: simple - name: enterer in: query description: The party responsible for the entry of the Claim style: simple - name: procedure-udi in: query description: UDI associated with a procedure style: simple - name: item-udi in: query description: UDI associated with a line item product or service style: simple - name: identifier in: query description: The primary identifier of the financial resource style: simple - name: created in: query description: The creation date for the Claim style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: encounter in: query description: Encounters associated with a billed line item style: simple - name: priority in: query description: Processing priority requested style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: subdetail-udi in: query description: "UDI associated with a line item, detail, subdetail product or\ \ service" style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: facility in: query description: Facility where the products or services have been or will be provided style: simple - name: status in: query description: The status of the Claim instance. style: simple 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: - Claim summary: "create-type: Create a new Claim instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Claim" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Claim/_history: get: tags: - Claim summary: "type-history: Fetch the resource change history for all resources\ \ of type Claim" 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' /Claim/{id}/_history: get: tags: - Claim summary: "instance-history: Fetch the resource change history for all resources\ \ of type Claim" 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' /Claim/$validate: get: tags: - Claim parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /Claim/{id}/$validate: get: tags: - Claim parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /Claim/{id}/$meta-delete: post: tags: - Claim description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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' /Claim/{id}/$meta-add: post: tags: - Claim description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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' /Claim/$meta: get: tags: - Claim description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /Claim/{id}/$meta: get: tags: - Claim description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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' /Claim/$expunge: post: tags: - Claim requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /Claim/{id}/$expunge: post: tags: - Claim 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /Claim/{id}/$graphql: get: tags: - Claim description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' /Claim/{id}/$binary-access-write: post: tags: - Claim 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": "path", "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' /Claim/{id}/$binary-access-read: get: tags: - Claim parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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' /Claim/{id}/$diff: get: tags: - Claim summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Condition summary: "update-instance: Update an existing Condition instance, or create\ \ using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Condition" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Condition summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Condition summary: "instance-patch: Patch a resource instance of type Condition by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Condition/{id}/_history/{version_id}: get: tags: - Condition summary: "vread-instance: Read Condition instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: onset-info in: query description: Onsets as a string style: simple - name: code in: query description: Code for the condition style: simple - name: evidence in: query description: Manifestation/symptom style: simple - name: resource-placeholder in: query description: "Search for resources of type [Condition] populated with the\ \ resource-placeholder extension" style: simple - name: subject in: query description: Who has the condition? style: simple - name: verification-status in: query description: unconfirmed | provisional | differential | confirmed | refuted | entered-in-error style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: clinical-status in: query description: The clinical status of the condition style: simple - name: onset-date in: query description: Date related onsets (dateTime and Period) style: simple - name: abatement-date in: query description: Date-related abatements (dateTime and period) style: simple - name: patient in: query description: Who has the condition? style: simple - name: abatement-age in: query description: Abatement as age or age range style: simple - name: evidence-detail in: query description: Supporting information found elsewhere style: simple - name: severity in: query description: The severity of the condition style: simple - name: identifier in: query description: A unique identifier of the condition record style: simple - name: recorded-date in: query description: Date record was first recorded style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: asserter in: query description: Person who asserts this condition style: simple - name: stage in: query description: Simple summary (disease specific) style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: abatement-string in: query description: Abatement as a string style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: onset-age in: query description: Onsets as age or age range style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: category in: query description: The category of the condition style: simple - name: body-site in: query description: "Anatomical location, if relevant" style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple 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: - Condition summary: "create-type: Create a new Condition instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Condition" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Condition/_history: get: tags: - Condition summary: "type-history: Fetch the resource change history for all resources\ \ of type Condition" 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}/_history: get: tags: - Condition summary: "instance-history: Fetch the resource change history for all resources\ \ of type Condition" 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/$validate: get: tags: - Condition parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Condition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Condition description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Condition description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Condition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Condition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Condition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Condition 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - Condition description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - Condition 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": "path", "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' /Condition/{id}/$binary-access-read: get: tags: - Condition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Condition summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /Coverage/{id}: get: tags: - Coverage summary: "read-instance: Read Coverage 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' put: tags: - Coverage summary: "update-instance: Update an existing Coverage instance, or create using\ \ a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Coverage" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Coverage summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Coverage summary: "instance-patch: Patch a resource instance of type Coverage by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Coverage/{id}/_history/{version_id}: get: tags: - Coverage summary: "vread-instance: Read Coverage instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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' /Coverage: get: tags: - Coverage summary: "search-type: Search for Coverage instances" description: This is a search type parameters: - name: identifier in: query description: The primary identifier of the insured and the coverage style: simple - name: subscriber in: query description: Reference to the subscriber style: simple - name: resource-placeholder in: query description: "Search for resources of type [Coverage] populated with the resource-placeholder\ \ extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: type in: query description: "The kind of coverage (health plan, auto, Workers Compensation)" style: simple - name: payor in: query description: The identity of the insurer or party paying for services style: simple - name: identifier-system-cvg-unique in: query style: simple - name: beneficiary in: query description: Covered party style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: patient in: query description: Retrieve coverages for a patient style: simple - name: identifier-system-cvg in: query description: A coverage identifier with system CVG style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: class-value in: query description: "Value of the class (eg. Plan number, group number)" style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: class-type in: query description: "Coverage class (eg. plan, group)" style: simple - name: dependent in: query description: Dependent number style: simple - name: policy-holder in: query description: Reference to the policyholder style: simple - name: status in: query description: The status of the Coverage style: simple 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: - Coverage summary: "create-type: Create a new Coverage instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Coverage" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Coverage/_history: get: tags: - Coverage summary: "type-history: Fetch the resource change history for all resources\ \ of type Coverage" 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' /Coverage/{id}/_history: get: tags: - Coverage summary: "instance-history: Fetch the resource change history for all resources\ \ of type Coverage" 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' /Coverage/$validate: get: tags: - Coverage parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /Coverage/{id}/$validate: get: tags: - Coverage parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /Coverage/{id}/$meta-delete: post: tags: - Coverage description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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' /Coverage/{id}/$meta-add: post: tags: - Coverage description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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' /Coverage/$meta: get: tags: - Coverage description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /Coverage/{id}/$meta: get: tags: - Coverage description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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' /Coverage/$expunge: post: tags: - Coverage requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /Coverage/{id}/$expunge: post: tags: - Coverage 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /Coverage/{id}/$graphql: get: tags: - Coverage description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' /Coverage/{id}/$binary-access-write: post: tags: - Coverage 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": "path", "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' /Coverage/{id}/$binary-access-read: get: tags: - Coverage parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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' /Coverage/{id}/$diff: get: tags: - Coverage summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Encounter summary: "update-instance: Update an existing Encounter instance, or create\ \ using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Encounter" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Encounter summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Encounter summary: "instance-patch: Patch a resource instance of type Encounter by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Encounter/{id}/_history/{version_id}: get: tags: - Encounter summary: "vread-instance: Read Encounter instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: date in: query description: A date within the period the Encounter lasted style: simple - name: participant-type in: query description: Role of participant in encounter style: simple - name: subject in: query description: The patient or group present at the encounter style: simple - name: resource-placeholder in: query description: "Search for resources of type [Encounter] populated with the\ \ resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: appointment in: query description: The appointment that scheduled this encounter style: simple - name: part-of in: query description: Another Encounter this encounter is part of style: simple - name: type in: query description: Specific type of encounter style: simple - name: participant in: query description: Persons involved in the encounter other than the patient style: simple - name: reason-code in: query description: Coded reason the encounter takes place style: simple - name: based-on in: query description: The ServiceRequest that initiated this encounter style: simple - name: patient in: query description: The patient or group present at the encounter style: simple - name: identifier-system-tx-unique in: query style: simple - name: location-period in: query description: Time period during which the patient was present at the location style: simple - name: special-arrangement in: query description: "Wheelchair, translator, stretcher, etc." style: simple - name: class in: query description: Classification of patient encounter style: simple - name: identifier in: query description: Identifier(s) by which this encounter is known style: simple - name: practitioner in: query description: Persons involved in the encounter other than the patient style: simple - name: episode-of-care in: query description: Episode(s) of care that this encounter should be recorded against style: simple - name: length in: query description: Length of encounter in days style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: diagnosis in: query description: The diagnosis or procedure relevant to the encounter style: simple - name: identifier-system-tx in: query description: An encounter identifier with system TX style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: reason-reference in: query description: Reason the encounter takes place (reference) style: simple - name: service-provider in: query description: The organization (facility) responsible for this encounter style: simple - name: location in: query description: Location the encounter takes place style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: account in: query description: The set of accounts that may be used for billing for this Encounter style: simple - name: status in: query description: planned | arrived | triaged | in-progress | onleave | finished | cancelled + style: simple 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: - Encounter summary: "create-type: Create a new Encounter instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Encounter" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Encounter/_history: get: tags: - Encounter summary: "type-history: Fetch the resource change history for all resources\ \ of type Encounter" 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}/_history: get: tags: - Encounter summary: "instance-history: Fetch the resource change history for all resources\ \ of type Encounter" 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/$validate: get: tags: - Encounter parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Encounter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Encounter description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Encounter description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Encounter description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Encounter description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Encounter requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Encounter 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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/$everything: get: tags: - Encounter parameters: - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: _offset in: query description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page. required: false style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range required: false style: simple - name: _content in: query description: "Filter the resources to return only resources matching the given\ \ _content filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _text in: query description: "Filter the resources to return only resources matching the given\ \ _text filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _filter in: query description: "Filter the resources to return only resources matching the given\ \ _filter filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _type in: query description: "Filter the resources to return only resources matching the given\ \ _type filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _id in: query description: Filter the resources to return based on the patient ids provided. required: false style: simple 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}/$everything: get: tags: - Encounter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: _offset in: query description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page. required: false style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range required: false style: simple - name: _content in: query description: "Filter the resources to return only resources matching the given\ \ _content filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _text in: query description: "Filter the resources to return only resources matching the given\ \ _text filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _filter in: query description: "Filter the resources to return only resources matching the given\ \ _filter filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _type in: query description: "Filter the resources to return only resources matching the given\ \ _type filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _id in: query description: Filter the resources to return based on the patient ids provided. required: false style: simple 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}/$graphql: get: tags: - Encounter description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - Encounter 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": "path", "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' /Encounter/{id}/$binary-access-read: get: tags: - Encounter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Encounter summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /ExplanationOfBenefit/{id}: get: tags: - ExplanationOfBenefit summary: "read-instance: Read ExplanationOfBenefit 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' put: tags: - ExplanationOfBenefit summary: "update-instance: Update an existing ExplanationOfBenefit instance,\ \ or create using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "ExplanationOfBenefit" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - ExplanationOfBenefit summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - ExplanationOfBenefit summary: "instance-patch: Patch a resource instance of type ExplanationOfBenefit\ \ by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /ExplanationOfBenefit/{id}/_history/{version_id}: get: tags: - ExplanationOfBenefit summary: "vread-instance: Read ExplanationOfBenefit instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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' /ExplanationOfBenefit: get: tags: - ExplanationOfBenefit summary: "search-type: Search for ExplanationOfBenefit instances" description: This is a search type parameters: - name: date in: query description: The explanation of benefit billable period start date style: simple - name: care-team in: query description: Member of the CareTeam style: simple - name: resource-placeholder in: query description: "Search for resources of type [ExplanationOfBenefit] populated\ \ with the resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: payee in: query description: The party receiving any payment for the Claim style: simple - name: identifier-system-uc-unique in: query style: simple - name: provider in: query description: The reference to the provider style: simple - name: patient in: query description: The reference to the patient style: simple - name: detail-udi in: query description: UDI associated with a line item detail product or service style: simple - name: identifier-system-uc in: query description: An explanation of benefit identifier with system uc style: simple - name: claim in: query description: The reference to the claim style: simple - name: enterer in: query description: The party responsible for the entry of the Claim style: simple - name: procedure-udi in: query description: UDI associated with a procedure style: simple - name: item-udi in: query description: UDI associated with a line item product or service style: simple - name: coverage in: query description: The plan under which the claim was adjudicated style: simple - name: identifier in: query description: The business identifier of the Explanation of Benefit style: simple - name: created in: query description: The creation date for the EOB style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: encounter in: query description: Encounters associated with a billed line item style: simple - name: disposition in: query description: The contents of the disposition message style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: prescription in: query description: Reference of the prescription authorizing services or products that is linked to this explanation of benefit style: simple - name: benefitPeriodStart in: query description: The explanation of benefit's plan benefit period start date style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: benefitPeriodEnd in: query description: The explanation of benefit's plan benefit period end date style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: subdetail-udi in: query description: UDI associated with a line item detail subdetail product or service style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: facility in: query description: Facility responsible for the goods and services style: simple - name: status in: query description: Status of the instance style: simple 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: - ExplanationOfBenefit summary: "create-type: Create a new ExplanationOfBenefit instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "ExplanationOfBenefit" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /ExplanationOfBenefit/_history: get: tags: - ExplanationOfBenefit summary: "type-history: Fetch the resource change history for all resources\ \ of type ExplanationOfBenefit" 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' /ExplanationOfBenefit/{id}/_history: get: tags: - ExplanationOfBenefit summary: "instance-history: Fetch the resource change history for all resources\ \ of type ExplanationOfBenefit" 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' /ExplanationOfBenefit/$validate: get: tags: - ExplanationOfBenefit parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /ExplanationOfBenefit/{id}/$validate: get: tags: - ExplanationOfBenefit parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /ExplanationOfBenefit/{id}/$meta-delete: post: tags: - ExplanationOfBenefit description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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' /ExplanationOfBenefit/{id}/$meta-add: post: tags: - ExplanationOfBenefit description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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' /ExplanationOfBenefit/$meta: get: tags: - ExplanationOfBenefit description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /ExplanationOfBenefit/{id}/$meta: get: tags: - ExplanationOfBenefit description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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' /ExplanationOfBenefit/$expunge: post: tags: - ExplanationOfBenefit requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /ExplanationOfBenefit/{id}/$expunge: post: tags: - ExplanationOfBenefit 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /ExplanationOfBenefit/{id}/$graphql: get: tags: - ExplanationOfBenefit description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' /ExplanationOfBenefit/{id}/$binary-access-write: post: tags: - ExplanationOfBenefit 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": "path", "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' /ExplanationOfBenefit/{id}/$binary-access-read: get: tags: - ExplanationOfBenefit parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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' /ExplanationOfBenefit/{id}/$diff: get: tags: - ExplanationOfBenefit summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /HealthcareService/{id}: get: tags: - HealthcareService summary: "read-instance: Read HealthcareService 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' put: tags: - HealthcareService summary: "update-instance: Update an existing HealthcareService instance, or\ \ create using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "HealthcareService" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - HealthcareService summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - HealthcareService summary: "instance-patch: Patch a resource instance of type HealthcareService\ \ by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /HealthcareService/{id}/_history/{version_id}: get: tags: - HealthcareService summary: "vread-instance: Read HealthcareService instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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' /HealthcareService: get: tags: - HealthcareService summary: "search-type: Search for HealthcareService instances" description: This is a search type parameters: - name: identifier-system-hcs-unique in: query style: simple - name: identifier in: query description: External identifiers for this item style: simple - name: specialty in: query description: The specialty of the service provided by this healthcare service style: simple - name: service-category in: query description: Service Category of the Healthcare Service style: simple - name: resource-placeholder in: query description: "Search for resources of type [HealthcareService] populated with\ \ the resource-placeholder extension" style: simple - name: service-type in: query description: The type of service provided by this healthcare service style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: active in: query description: The Healthcare Service is currently marked as active style: simple - name: program in: query description: One of the Programs supported by this HealthcareService style: simple - name: characteristic in: query description: One of the HealthcareService's characteristics style: simple - name: endpoint in: query description: Technical endpoints providing access to electronic services operated for the healthcare service style: simple - name: identifier-system-hcs in: query description: A healthcare service identifier with system HCS style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: coverage-area in: query description: Location(s) service is intended for/available to style: simple - name: organization in: query description: The organization that provides this Healthcare Service style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: name in: query description: A portion of the Healthcare service name style: simple - name: location in: query description: The location of the Healthcare Service style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple 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: - HealthcareService summary: "create-type: Create a new HealthcareService instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "HealthcareService" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /HealthcareService/_history: get: tags: - HealthcareService summary: "type-history: Fetch the resource change history for all resources\ \ of type HealthcareService" 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' /HealthcareService/{id}/_history: get: tags: - HealthcareService summary: "instance-history: Fetch the resource change history for all resources\ \ of type HealthcareService" 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' /HealthcareService/$validate: get: tags: - HealthcareService parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /HealthcareService/{id}/$validate: get: tags: - HealthcareService parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /HealthcareService/{id}/$meta-delete: post: tags: - HealthcareService description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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' /HealthcareService/{id}/$meta-add: post: tags: - HealthcareService description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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' /HealthcareService/$meta: get: tags: - HealthcareService description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /HealthcareService/{id}/$meta: get: tags: - HealthcareService description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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' /HealthcareService/$expunge: post: tags: - HealthcareService requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /HealthcareService/{id}/$expunge: post: tags: - HealthcareService 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /HealthcareService/{id}/$graphql: get: tags: - HealthcareService description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' /HealthcareService/{id}/$binary-access-write: post: tags: - HealthcareService 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": "path", "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' /HealthcareService/{id}/$binary-access-read: get: tags: - HealthcareService parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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' /HealthcareService/{id}/$diff: get: tags: - HealthcareService summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Immunization summary: "update-instance: Update an existing Immunization instance, or create\ \ using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Immunization" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Immunization summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Immunization summary: "instance-patch: Patch a resource instance of type Immunization by\ \ ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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}/_history/{version_id}: get: tags: - Immunization summary: "vread-instance: Read Immunization instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: date in: query description: Vaccination (non)-Administration Date style: simple - name: lot-number in: query description: Vaccine Lot Number style: simple - name: resource-placeholder in: query description: "Search for resources of type [Immunization] populated with the\ \ resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: status-reason in: query description: Reason why the vaccine was not administered style: simple - name: reason-code in: query description: Reason why the vaccine was administered style: simple - name: manufacturer in: query description: Vaccine Manufacturer style: simple - name: patient in: query description: The patient for the vaccination record style: simple - name: reaction-date in: query description: When reaction started style: simple - name: identifier in: query description: Business identifier style: simple - name: reaction in: query description: Additional information on reaction style: simple - name: performer in: query description: The practitioner or organization who played a role in the vaccination style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: target-disease in: query description: The target disease the dose is being administered against style: simple - name: series in: query description: The series being followed by the provider style: simple - name: vaccine-code in: query description: Vaccine Product Administered style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: reason-reference in: query description: Why immunization occurred style: simple - name: location in: query description: The service delivery location or facility in which the vaccine was / was to be administered style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: status in: query description: Immunization event status style: simple 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: - Immunization summary: "create-type: Create a new Immunization instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Immunization" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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/_history: get: tags: - Immunization summary: "type-history: Fetch the resource change history for all resources\ \ of type Immunization" 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}/_history: get: tags: - Immunization summary: "instance-history: Fetch the resource change history for all resources\ \ of type Immunization" 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/$validate: get: tags: - Immunization parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Immunization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Immunization description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Immunization description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Immunization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Immunization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Immunization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Immunization 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - Immunization description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - Immunization 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": "path", "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}/$binary-access-read: get: tags: - Immunization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Immunization summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /InsurancePlan/{id}: get: tags: - InsurancePlan summary: "read-instance: Read InsurancePlan 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' put: tags: - InsurancePlan summary: "update-instance: Update an existing InsurancePlan instance, or create\ \ using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "InsurancePlan" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - InsurancePlan summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - InsurancePlan summary: "instance-patch: Patch a resource instance of type InsurancePlan by\ \ ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /InsurancePlan/{id}/_history/{version_id}: get: tags: - InsurancePlan summary: "vread-instance: Read InsurancePlan instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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' /InsurancePlan: get: tags: - InsurancePlan summary: "search-type: Search for InsurancePlan instances" description: This is a search type parameters: - name: address-state in: query description: A state specified in an address style: simple - name: resource-placeholder in: query description: "Search for resources of type [InsurancePlan] populated with\ \ the resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: identifier-system-pln-unique in: query style: simple - name: type in: query description: A code for the type of organization style: simple - name: address-country in: query description: A country specified in an address style: simple - name: administered-by in: query description: Product administrator style: simple - name: endpoint in: query description: Technical endpoint style: simple - name: phonetic in: query description: A portion of the organization's name using some kind of phonetic matching algorithm style: simple - name: address-city in: query description: A city specified in an address style: simple - name: identifier in: query description: Any identifier for the organization (not the accreditation issuer's identifier) style: simple - 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" style: simple - name: owned-by in: query description: An organization of which this organization forms a part style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: identifier-system-pln in: query description: An insurance plan identifier with system PLN style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: status in: query description: Is the Organization record active style: simple 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: - InsurancePlan summary: "create-type: Create a new InsurancePlan instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "InsurancePlan" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /InsurancePlan/_history: get: tags: - InsurancePlan summary: "type-history: Fetch the resource change history for all resources\ \ of type InsurancePlan" 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' /InsurancePlan/{id}/_history: get: tags: - InsurancePlan summary: "instance-history: Fetch the resource change history for all resources\ \ of type InsurancePlan" 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' /InsurancePlan/$validate: get: tags: - InsurancePlan parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /InsurancePlan/{id}/$validate: get: tags: - InsurancePlan parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /InsurancePlan/{id}/$meta-delete: post: tags: - InsurancePlan description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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' /InsurancePlan/{id}/$meta-add: post: tags: - InsurancePlan description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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' /InsurancePlan/$meta: get: tags: - InsurancePlan description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /InsurancePlan/{id}/$meta: get: tags: - InsurancePlan description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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' /InsurancePlan/$expunge: post: tags: - InsurancePlan requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /InsurancePlan/{id}/$expunge: post: tags: - InsurancePlan 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /InsurancePlan/{id}/$graphql: get: tags: - InsurancePlan description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' /InsurancePlan/{id}/$binary-access-write: post: tags: - InsurancePlan 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": "path", "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' /InsurancePlan/{id}/$binary-access-read: get: tags: - InsurancePlan parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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' /InsurancePlan/{id}/$diff: get: tags: - InsurancePlan summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /List/{id}: get: tags: - List summary: "read-instance: Read List 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' put: tags: - List summary: "update-instance: Update an existing List instance, or create using\ \ a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "List" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - List summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - List summary: "instance-patch: Patch a resource instance of type List by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /List/{id}/_history/{version_id}: get: tags: - List summary: "vread-instance: Read List instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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' /List: get: tags: - List summary: "search-type: Search for List instances" description: This is a search type parameters: - name: date in: query description: When the list was prepared style: simple - name: identifier in: query description: Business identifier style: simple - name: item in: query description: Actual entry style: simple - name: empty-reason in: query description: Why list is empty style: simple - name: notes in: query description: The annotation - text content (as markdown) style: simple - name: code in: query description: What the purpose of this list is style: simple - name: subject in: query description: If all resources have the same subject style: simple - name: resource-placeholder in: query description: "Search for resources of type [List] populated with the resource-placeholder\ \ extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: encounter in: query description: Context in which list created style: simple - name: source in: query description: Who and/or what defined the list contents (aka Author) style: simple - name: title in: query description: Descriptive name for the list style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: patient in: query description: If all resources have the same subject style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: status in: query description: current | retired | entered-in-error style: simple 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: - List summary: "create-type: Create a new List instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "List" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /List/_history: get: tags: - List summary: "type-history: Fetch the resource change history for all resources\ \ of type List" 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' /List/{id}/_history: get: tags: - List summary: "instance-history: Fetch the resource change history for all resources\ \ of type List" 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' /List/$validate: get: tags: - List parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /List/{id}/$validate: get: tags: - List parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /List/{id}/$meta-delete: post: tags: - List description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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' /List/{id}/$meta-add: post: tags: - List description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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' /List/$meta: get: tags: - List description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /List/{id}/$meta: get: tags: - List description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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' /List/$expunge: post: tags: - List requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /List/{id}/$expunge: post: tags: - List 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /List/{id}/$graphql: get: tags: - List description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' /List/{id}/$binary-access-write: post: tags: - List 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": "path", "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' /List/{id}/$binary-access-read: get: tags: - List parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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' /List/{id}/$diff: get: tags: - List summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Location summary: "update-instance: Update an existing Location instance, or create using\ \ a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Location" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Location summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Location summary: "instance-patch: Patch a resource instance of type Location by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Location/{id}/_history/{version_id}: get: tags: - Location summary: "vread-instance: Read Location instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: address-state in: query description: A state specified in an address style: simple - name: resource-placeholder in: query description: "Search for resources of type [Location] populated with the resource-placeholder\ \ extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: operational-status in: query description: "Searches for locations (typically bed/room) that have an operational\ \ status (e.g. contaminated, housekeeping)" style: simple - name: identifier-system-loc in: query description: A location identifier with system LOC style: simple - name: type in: query description: A code for the type of location style: simple - name: address-country in: query description: A country specified in an address style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the location style: simple - name: near in: query description: |- Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also style: simple - name: address-city in: query description: A city specified in an address style: simple - name: partof in: query description: A location of which this location is a part style: simple - name: identifier in: query description: An identifier for the location style: simple - name: address in: query description: A (part of the) address of the location style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: identifier-system-loc-unique in: query style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: organization in: query description: Searches for locations that are managed by the provided organization style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: name in: query description: A portion of the location's name or alias style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: status in: query description: Searches for locations with a specific kind of status style: simple 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: - Location summary: "create-type: Create a new Location instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Location" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Location/_history: get: tags: - Location summary: "type-history: Fetch the resource change history for all resources\ \ of type Location" 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}/_history: get: tags: - Location summary: "instance-history: Fetch the resource change history for all resources\ \ of type Location" 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/$validate: get: tags: - Location parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Location parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Location description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Location description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Location description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Location description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Location requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Location 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - Location description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - Location 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": "path", "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' /Location/{id}/$binary-access-read: get: tags: - Location parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Location summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Medication summary: "update-instance: Update an existing Medication instance, or create\ \ using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Medication" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Medication summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Medication summary: "instance-patch: Patch a resource instance of type Medication by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Medication/{id}/_history/{version_id}: get: tags: - Medication summary: "vread-instance: Read Medication instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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 parameters: - name: identifier in: query description: Returns medications with this external identifier style: simple - name: code in: query description: Returns medications for a specific code style: simple - name: ingredient in: query description: Returns medications for this ingredient reference style: simple - name: lot-number in: query description: Returns medications in a batch with this lot number style: simple - name: resource-placeholder in: query description: "Search for resources of type [Medication] populated with the\ \ resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: manufacturer in: query description: Returns medications made or sold for this manufacturer style: simple - name: ingredient-code in: query description: Returns medications for this ingredient code style: simple - name: form in: query description: Returns medications for a specific dose form style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: expiration-date in: query description: Returns medications in a batch with this expiration date style: simple - name: status in: query description: Returns medications for this status style: simple 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: - Medication summary: "create-type: Create a new Medication instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Medication" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Medication/_history: get: tags: - Medication summary: "type-history: Fetch the resource change history for all resources\ \ of type Medication" 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}/_history: get: tags: - Medication summary: "instance-history: Fetch the resource change history for all resources\ \ of type Medication" 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/$validate: get: tags: - Medication parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Medication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Medication description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Medication description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Medication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Medication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Medication requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Medication 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - Medication description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - Medication 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": "path", "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' /Medication/{id}/$binary-access-read: get: tags: - Medication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Medication summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /MedicationDispense/{id}: get: tags: - MedicationDispense summary: "read-instance: Read MedicationDispense 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' put: tags: - MedicationDispense summary: "update-instance: Update an existing MedicationDispense instance, or\ \ create using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "MedicationDispense" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - MedicationDispense summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - MedicationDispense summary: "instance-patch: Patch a resource instance of type MedicationDispense\ \ by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /MedicationDispense/{id}/_history/{version_id}: get: tags: - MedicationDispense summary: "vread-instance: Read MedicationDispense instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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' /MedicationDispense: get: tags: - MedicationDispense summary: "search-type: Search for MedicationDispense instances" description: This is a search type parameters: - name: code in: query description: Returns dispenses of this medicine code style: simple - name: resource-placeholder in: query description: "Search for resources of type [MedicationDispense] populated\ \ with the resource-placeholder extension" style: simple - name: subject in: query description: The identity of a patient for whom to list dispenses style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: destination in: query description: Returns dispenses that should be sent to a specific destination style: simple - name: type in: query description: Returns dispenses of a specific type style: simple - name: patient in: query description: The identity of a patient to list dispenses for style: simple - name: context in: query description: Returns dispenses with a specific context (episode or episode of care) style: simple - name: identifier in: query description: Returns dispenses with this external identifier style: simple - name: performer in: query description: Returns dispenses performed by a specific individual style: simple - name: receiver in: query description: The identity of a receiver to list dispenses for style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: responsibleparty in: query description: Returns dispenses with the specified responsible party style: simple - name: medication in: query description: Returns dispenses of this medicine resource style: simple - name: whenhandedover in: query description: Returns dispenses handed over on this date style: simple - name: whenprepared in: query description: Returns dispenses prepared on this date style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: prescription in: query description: The identity of a prescription to list dispenses from style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: status in: query description: Returns dispenses with a specified dispense status style: simple 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: - MedicationDispense summary: "create-type: Create a new MedicationDispense instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "MedicationDispense" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /MedicationDispense/_history: get: tags: - MedicationDispense summary: "type-history: Fetch the resource change history for all resources\ \ of type MedicationDispense" 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' /MedicationDispense/{id}/_history: get: tags: - MedicationDispense summary: "instance-history: Fetch the resource change history for all resources\ \ of type MedicationDispense" 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' /MedicationDispense/$validate: get: tags: - MedicationDispense parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /MedicationDispense/{id}/$validate: get: tags: - MedicationDispense parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /MedicationDispense/{id}/$meta-delete: post: tags: - MedicationDispense description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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' /MedicationDispense/{id}/$meta-add: post: tags: - MedicationDispense description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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' /MedicationDispense/$meta: get: tags: - MedicationDispense description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /MedicationDispense/{id}/$meta: get: tags: - MedicationDispense description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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' /MedicationDispense/$expunge: post: tags: - MedicationDispense requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /MedicationDispense/{id}/$expunge: post: tags: - MedicationDispense 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /MedicationDispense/{id}/$graphql: get: tags: - MedicationDispense description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' /MedicationDispense/{id}/$binary-access-write: post: tags: - MedicationDispense 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": "path", "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' /MedicationDispense/{id}/$binary-access-read: get: tags: - MedicationDispense parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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' /MedicationDispense/{id}/$diff: get: tags: - MedicationDispense summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /MedicationKnowledge/{id}: get: tags: - MedicationKnowledge summary: "read-instance: Read MedicationKnowledge 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' put: tags: - MedicationKnowledge summary: "update-instance: Update an existing MedicationKnowledge instance,\ \ or create using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "MedicationKnowledge" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - MedicationKnowledge summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - MedicationKnowledge summary: "instance-patch: Patch a resource instance of type MedicationKnowledge\ \ by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /MedicationKnowledge/{id}/_history/{version_id}: get: tags: - MedicationKnowledge summary: "vread-instance: Read MedicationKnowledge instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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' /MedicationKnowledge: get: tags: - MedicationKnowledge summary: "search-type: Search for MedicationKnowledge instances" description: This is a search type parameters: - name: code in: query description: Code that identifies this medication style: simple - name: ingredient in: query description: Medication(s) or substance(s) contained in the medication style: simple - name: doseform in: query description: powder | tablets | capsule + style: simple - name: resource-placeholder in: query description: "Search for resources of type [MedicationKnowledge] populated\ \ with the resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: classification-type in: query description: "The type of category for the medication (for example, therapeutic\ \ classification, therapeutic sub-classification)" style: simple - name: monograph-type in: query description: The category of medication document style: simple - name: classification in: query description: Specific category assigned to the medication style: simple - name: manufacturer in: query description: Manufacturer of the item style: simple - name: ingredient-code in: query description: Medication(s) or substance(s) contained in the medication style: simple - name: source-cost in: query description: The source or owner for the price information style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: monograph in: query description: Associated documentation about the medication style: simple - name: monitoring-program-name in: query description: Name of the reviewing program style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: monitoring-program-type in: query description: Type of program under which the medication is monitored style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: status in: query description: active | inactive | entered-in-error style: simple 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: - MedicationKnowledge summary: "create-type: Create a new MedicationKnowledge instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "MedicationKnowledge" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /MedicationKnowledge/_history: get: tags: - MedicationKnowledge summary: "type-history: Fetch the resource change history for all resources\ \ of type MedicationKnowledge" 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' /MedicationKnowledge/{id}/_history: get: tags: - MedicationKnowledge summary: "instance-history: Fetch the resource change history for all resources\ \ of type MedicationKnowledge" 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' /MedicationKnowledge/$validate: get: tags: - MedicationKnowledge parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /MedicationKnowledge/{id}/$validate: get: tags: - MedicationKnowledge parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /MedicationKnowledge/{id}/$meta-delete: post: tags: - MedicationKnowledge description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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' /MedicationKnowledge/{id}/$meta-add: post: tags: - MedicationKnowledge description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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' /MedicationKnowledge/$meta: get: tags: - MedicationKnowledge description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /MedicationKnowledge/{id}/$meta: get: tags: - MedicationKnowledge description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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' /MedicationKnowledge/$expunge: post: tags: - MedicationKnowledge requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /MedicationKnowledge/{id}/$expunge: post: tags: - MedicationKnowledge 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /MedicationKnowledge/{id}/$graphql: get: tags: - MedicationKnowledge description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' /MedicationKnowledge/{id}/$binary-access-write: post: tags: - MedicationKnowledge 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": "path", "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' /MedicationKnowledge/{id}/$binary-access-read: get: tags: - MedicationKnowledge parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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' /MedicationKnowledge/{id}/$diff: get: tags: - MedicationKnowledge summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - MedicationRequest summary: "update-instance: Update an existing MedicationRequest instance, or\ \ create using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "MedicationRequest" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - MedicationRequest summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - MedicationRequest summary: "instance-patch: Patch a resource instance of type MedicationRequest\ \ by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /MedicationRequest/{id}/_history/{version_id}: get: tags: - MedicationRequest summary: "vread-instance: Read MedicationRequest instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: date in: query description: Returns medication request to be administered on a specific date style: simple - name: authoredon in: query description: Return prescriptions written on this date style: simple - name: code in: query description: Return prescriptions of this medication code style: simple - name: subject in: query description: The identity of a patient to list orders for style: simple - name: resource-placeholder in: query description: "Search for resources of type [MedicationRequest] populated with\ \ the resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: intended-performer in: query description: Returns the intended performer of the administration of the medication request style: simple - name: patient in: query description: Returns prescriptions for a specific patient style: simple - name: intended-performertype in: query description: Returns requests for a specific type of performer style: simple - name: requester in: query description: Returns prescriptions prescribed by this prescriber style: simple - name: identifier in: query description: Return prescriptions with this external identifier style: simple - name: intended-dispenser in: query description: Returns prescriptions intended to be dispensed by this Organization style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: medication in: query description: Return prescriptions for this medication reference style: simple - name: encounter in: query description: Return prescriptions with this encounter identifier style: simple - name: priority in: query description: Returns prescriptions with different priorities style: simple - name: intent in: query description: Returns prescriptions with different intents style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: category in: query description: Returns prescriptions with different categories style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: status in: query description: Status of the prescription style: simple 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: - MedicationRequest summary: "create-type: Create a new MedicationRequest instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "MedicationRequest" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /MedicationRequest/_history: get: tags: - MedicationRequest summary: "type-history: Fetch the resource change history for all resources\ \ of type MedicationRequest" 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}/_history: get: tags: - MedicationRequest summary: "instance-history: Fetch the resource change history for all resources\ \ of type MedicationRequest" 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/$validate: get: tags: - MedicationRequest parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - MedicationRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - MedicationRequest description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - MedicationRequest description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - MedicationRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - MedicationRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - MedicationRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - MedicationRequest 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - MedicationRequest description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - MedicationRequest 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": "path", "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' /MedicationRequest/{id}/$binary-access-read: get: tags: - MedicationRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - MedicationRequest summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Observation summary: "update-instance: Update an existing Observation instance, or create\ \ using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Observation" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Observation summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Observation summary: "instance-patch: Patch a resource instance of type Observation by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Observation/{id}/_history/{version_id}: get: tags: - Observation summary: "vread-instance: Read Observation instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: date in: query description: "Obtained date/time. If the obtained element is a period, a date\ \ that falls in the period" style: simple - name: combo-data-absent-reason in: query description: "The reason why the expected value in the element Observation.value[x]\ \ or Observation.component.value[x] is missing." style: simple - name: code in: query description: The code of the observation type style: simple - name: component-data-absent-reason in: query description: "The reason why the expected value in the element Observation.component.value[x]\ \ is missing." style: simple - name: resource-placeholder in: query description: "Search for resources of type [Observation] populated with the\ \ resource-placeholder extension" style: simple - name: subject in: query description: The subject that the observation is about style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: value-date in: query description: "The value of the observation, if the value is a date or period\ \ of time" style: simple - name: value-concept in: query description: "The value of the observation, if the value is a CodeableConcept" style: simple - name: derived-from in: query description: Related measurements the observation is made from style: simple - name: focus in: query description: The focus of an observation when the focus is not the patient of record. style: simple - name: part-of in: query description: Part of referenced event style: simple - name: has-member in: query description: Related resource that belongs to the Observation group style: simple - name: based-on in: query description: Reference to the service request. style: simple - name: patient in: query description: The subject that the observation is about (if patient) style: simple - name: specimen in: query description: Specimen used for this observation style: simple - name: component-code in: query description: The component code of the observation type style: simple - name: value-string in: query description: "The value of the observation, if the value is a string, and\ \ also searches in CodeableConcept.text" style: simple - name: identifier in: query description: The unique id for a particular observation style: simple - name: performer in: query description: Who performed the observation style: simple - name: combo-code in: query description: The code of the observation type or component type style: simple - name: method in: query description: The method used for the observation style: simple - name: value-quantity in: query description: "The value of the observation, if the value is a Quantity, or\ \ a SampledData (just search on the bounds of the values in sampled data)" style: simple - name: component-value-quantity in: query description: "The value of the component observation, if the value is a Quantity,\ \ or a SampledData (just search on the bounds of the values in sampled data)" style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: data-absent-reason in: query description: "The reason why the expected value in the element Observation.value[x]\ \ is missing." style: simple - name: combo-value-quantity in: query description: "The value or component value of the observation, if the value\ \ is a Quantity, or a SampledData (just search on the bounds of the values\ \ in sampled data)" style: simple - name: encounter in: query description: Encounter related to the observation style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: component-value-concept in: query description: "The value of the component observation, if the value is a CodeableConcept" style: simple - name: _id in: query description: The ID of the resource style: simple - name: category in: query description: The classification of the type of observation style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: device in: query description: The Device that generated the observation data. style: simple - name: combo-value-concept in: query description: "The value or component value of the observation, if the value\ \ is a CodeableConcept" style: simple - name: status in: query description: The status of the observation style: simple 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: - Observation summary: "create-type: Create a new Observation instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Observation" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Observation/_history: get: tags: - Observation summary: "type-history: Fetch the resource change history for all resources\ \ of type Observation" 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}/_history: get: tags: - Observation summary: "instance-history: Fetch the resource change history for all resources\ \ of type Observation" 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/$validate: get: tags: - Observation parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Observation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Observation description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Observation description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Observation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Observation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Observation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Observation 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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/$lastn: get: tags: - Observation parameters: - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: category in: query description: The classification of the type of observation required: false style: simple - name: code in: query description: The code of the observation type required: false style: simple - name: date in: query description: The effective date of the observation required: false style: simple - name: patient in: query description: The subject that the observation is about (if patient) required: false style: simple - name: subject in: query description: The subject that the observation is about required: false style: simple - name: max in: query description: The maximum number of observations to return for each observation code required: false style: simple 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}/$graphql: get: tags: - Observation description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - Observation 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": "path", "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' /Observation/{id}/$binary-access-read: get: tags: - Observation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Observation summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Organization summary: "update-instance: Update an existing Organization instance, or create\ \ using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Organization" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Organization summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Organization summary: "instance-patch: Patch a resource instance of type Organization by\ \ ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Organization/{id}/_history/{version_id}: get: tags: - Organization summary: "vread-instance: Read Organization instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: identifier-system-ntwk-unique in: query style: simple - name: address-state in: query description: A state specified in an address style: simple - name: resource-placeholder in: query description: "Search for resources of type [Organization] populated with the\ \ resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: identifier-system-ntwk in: query description: An organization identifier with system NTWK style: simple - name: type in: query description: A code for the type of organization style: simple - name: address-country in: query description: A country specified in an address style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the organization style: simple - name: phonetic in: query description: A portion of the organization's name using some kind of phonetic matching algorithm style: simple - name: address-city in: query description: A city specified in an address style: simple - name: partof in: query description: An organization of which this organization forms a part style: simple - name: identifier in: query description: Any identifier for the organization (not the accreditation issuer's identifier) style: simple - 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" style: simple - name: identifier-system-prn-unique in: query style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: active in: query description: Is the Organization record active style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: A portion of the organization's name or alias style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: identifier-system-prn in: query description: An organization identifier with system PRN style: simple 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: - Organization summary: "create-type: Create a new Organization instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Organization" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Organization/_history: get: tags: - Organization summary: "type-history: Fetch the resource change history for all resources\ \ of type Organization" 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}/_history: get: tags: - Organization summary: "instance-history: Fetch the resource change history for all resources\ \ of type Organization" 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/$validate: get: tags: - Organization parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Organization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Organization description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Organization description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Organization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Organization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Organization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Organization 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - Organization description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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}/$binary-access-write: post: tags: - Organization 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": "path", "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' /Organization/{id}/$binary-access-read: get: tags: - Organization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Organization summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' /OrganizationAffiliation/{id}: get: tags: - OrganizationAffiliation summary: "read-instance: Read OrganizationAffiliation 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' put: tags: - OrganizationAffiliation summary: "update-instance: Update an existing OrganizationAffiliation instance,\ \ or create using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "OrganizationAffiliation" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - OrganizationAffiliation summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - OrganizationAffiliation summary: "instance-patch: Patch a resource instance of type OrganizationAffiliation\ \ by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /OrganizationAffiliation/{id}/_history/{version_id}: get: tags: - OrganizationAffiliation summary: "vread-instance: Read OrganizationAffiliation instance with specific\ \ version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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' /OrganizationAffiliation: get: tags: - OrganizationAffiliation summary: "search-type: Search for OrganizationAffiliation instances" description: This is a search type parameters: - name: identifier-system-pra-unique in: query style: simple - name: date in: query description: The period during which the participatingOrganization is affiliated with the primary organization style: simple - name: specialty in: query description: Specific specialty of the participatingOrganization in the context of the role style: simple - name: role in: query description: Definition of the role the participatingOrganization plays style: simple - name: resource-placeholder in: query description: "Search for resources of type [OrganizationAffiliation] populated\ \ with the resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: network in: query description: Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for this role style: simple - name: telecom in: query description: The value in any kind of contact style: simple - name: email in: query description: A value in an email contact style: simple - name: identifier in: query description: An organization affiliation's Identifier style: simple - name: identifier-system-pra in: query description: An organization affiliation identifier with system PRA style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: active in: query description: Whether this organization affiliation record is in active use style: simple - name: primary-organization in: query description: The organization that receives the services from the participating organization style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: phone in: query description: A value in a phone contact style: simple - name: service in: query description: Healthcare services provided through the role style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: participating-organization in: query description: The organization that provides services to the primary organization style: simple - name: location in: query description: The location(s) at which the role occurs style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple 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: - OrganizationAffiliation summary: "create-type: Create a new OrganizationAffiliation instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "OrganizationAffiliation" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /OrganizationAffiliation/_history: get: tags: - OrganizationAffiliation summary: "type-history: Fetch the resource change history for all resources\ \ of type OrganizationAffiliation" 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' /OrganizationAffiliation/{id}/_history: get: tags: - OrganizationAffiliation summary: "instance-history: Fetch the resource change history for all resources\ \ of type OrganizationAffiliation" 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' /OrganizationAffiliation/$validate: get: tags: - OrganizationAffiliation parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /OrganizationAffiliation/{id}/$validate: get: tags: - OrganizationAffiliation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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' /OrganizationAffiliation/{id}/$meta-delete: post: tags: - OrganizationAffiliation description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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' /OrganizationAffiliation/{id}/$meta-add: post: tags: - OrganizationAffiliation description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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' /OrganizationAffiliation/$meta: get: tags: - OrganizationAffiliation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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' /OrganizationAffiliation/{id}/$meta: get: tags: - OrganizationAffiliation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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' /OrganizationAffiliation/$expunge: post: tags: - OrganizationAffiliation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /OrganizationAffiliation/{id}/$expunge: post: tags: - OrganizationAffiliation 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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' /OrganizationAffiliation/{id}/$graphql: get: tags: - OrganizationAffiliation description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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' /OrganizationAffiliation/{id}/$binary-access-write: post: tags: - OrganizationAffiliation 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": "path", "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' /OrganizationAffiliation/{id}/$binary-access-read: get: tags: - OrganizationAffiliation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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' /OrganizationAffiliation/{id}/$diff: get: tags: - OrganizationAffiliation summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Patient summary: "update-instance: Update an existing Patient instance, or create using\ \ a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Patient" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Patient summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Patient summary: "instance-patch: Patch a resource instance of type Patient by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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}/_history/{version_id}: get: tags: - Patient summary: "vread-instance: Read Patient instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: deceased in: query description: "This patient has been marked as deceased, or as a death date\ \ entered" style: simple - name: birthdate in: query description: The patient's date of birth style: simple - name: gender in: query description: Gender of the patient style: simple - name: address-state in: query description: A state specified in an address style: simple - name: resource-placeholder in: query description: "Search for resources of type [Patient] populated with the resource-placeholder\ \ extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: link in: query description: All patients linked to the given patient style: simple - name: language in: query description: Language code (irrespective of use value) style: simple - name: address-country in: query description: A country specified in an address style: simple - name: death-date in: query description: The date of death has been provided and satisfies this search value style: simple - name: phonetic in: query description: A portion of either family or given name using some kind of phonetic matching algorithm style: simple - name: telecom in: query description: The value in any kind of telecom details of the patient style: simple - name: address-city in: query description: A city specified in an address style: simple - name: email in: query description: A value in an email contact style: simple - name: identifier-system-mb in: query description: A patient identifier with system MB style: simple - name: identifier in: query description: A patient identifier style: simple - name: given in: query description: A portion of the given name of the patient style: simple - 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" style: simple - name: staffFlag in: query description: Boolean flag declaring if member is a member of staff style: simple - name: general-practitioner in: query description: "Patient's nominated general practitioner, not the organization\ \ that manages the record" style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: active in: query description: Whether the patient record is active style: simple - name: address-postalcode in: query description: A postalCode specified in an address style: simple - name: identifier-system-mb-unique in: query style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: phone in: query description: A value in a phone contact style: simple - name: organization in: query description: The organization that is the custodian of the patient record style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: address-use in: query description: A use code specified in an address style: simple - 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" style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: family in: query description: A portion of the family name of the patient style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple 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: "create-type: Create a new Patient instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Patient" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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/_history: get: tags: - Patient summary: "type-history: Fetch the resource change history for all resources\ \ of type Patient" 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}/_history: get: tags: - Patient summary: "instance-history: Fetch the resource change history for all resources\ \ of type Patient" 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/$member-match: post: tags: - Patient requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "MemberPatient" }, { "name": "OldCoverage" }, { "name": "NewCoverage" }, { "name": "MemberIdentifier" } ] } 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/$validate: get: tags: - Patient parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Patient description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Patient description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Patient description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Patient description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Patient requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Patient 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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/$everything: get: tags: - Patient parameters: - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: _offset in: query description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page. required: false style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range required: false style: simple - name: _content in: query description: "Filter the resources to return only resources matching the given\ \ _content filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _text in: query description: "Filter the resources to return only resources matching the given\ \ _text filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _filter in: query description: "Filter the resources to return only resources matching the given\ \ _filter filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _type in: query description: "Filter the resources to return only resources matching the given\ \ _type filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _id in: query description: Filter the resources to return based on the patient ids provided. required: false style: simple 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}/$everything: get: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: _offset in: query description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page. required: false style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range required: false style: simple - name: _content in: query description: "Filter the resources to return only resources matching the given\ \ _content filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _text in: query description: "Filter the resources to return only resources matching the given\ \ _text filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _filter in: query description: "Filter the resources to return only resources matching the given\ \ _filter filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _type in: query description: "Filter the resources to return only resources matching the given\ \ _type filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _id in: query description: Filter the resources to return based on the patient ids provided. required: false style: simple 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}/$graphql: get: tags: - Patient description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - Patient 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": "path", "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}/$binary-access-read: get: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Patient summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Practitioner summary: "update-instance: Update an existing Practitioner instance, or create\ \ using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Practitioner" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Practitioner summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Practitioner summary: "instance-patch: Patch a resource instance of type Practitioner by\ \ ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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}/_history/{version_id}: get: tags: - Practitioner summary: "vread-instance: Read Practitioner instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: address-state in: query description: A state specified in an address style: simple - name: gender in: query description: Gender of the practitioner style: simple - name: resource-placeholder in: query description: "Search for resources of type [Practitioner] populated with the\ \ resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: address-country in: query description: A country specified in an address style: simple - name: phonetic in: query description: A portion of either family or given name using some kind of phonetic matching algorithm style: simple - name: telecom in: query description: The value in any kind of contact style: simple - name: address-city in: query description: A city specified in an address style: simple - name: communication in: query description: One of the languages that the practitioner can communicate with style: simple - name: email in: query description: A value in an email contact style: simple - name: given in: query description: A portion of the given name style: simple - name: identifier in: query description: A practitioner's Identifier style: simple - 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" style: simple - name: identifier-system-prn-unique in: query style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: active in: query description: Whether the practitioner record is active style: simple - name: address-postalcode in: query description: A postalCode specified in an address style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: phone in: query description: A value in a phone contact style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: address-use in: query description: A use code specified in an address style: simple - 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" style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: family in: query description: A portion of the family name style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: identifier-system-prn in: query description: A practitioner identifier with system PRN style: simple 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: - Practitioner summary: "create-type: Create a new Practitioner instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Practitioner" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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/_history: get: tags: - Practitioner summary: "type-history: Fetch the resource change history for all resources\ \ of type Practitioner" 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}/_history: get: tags: - Practitioner summary: "instance-history: Fetch the resource change history for all resources\ \ of type Practitioner" 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/$validate: get: tags: - Practitioner parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Practitioner parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Practitioner description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Practitioner description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Practitioner description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Practitioner description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Practitioner requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Practitioner 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - Practitioner description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - Practitioner 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": "path", "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}/$binary-access-read: get: tags: - Practitioner parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Practitioner summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - PractitionerRole summary: "update-instance: Update an existing PractitionerRole instance, or\ \ create using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "PractitionerRole" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - PractitionerRole summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - PractitionerRole summary: "instance-patch: Patch a resource instance of type PractitionerRole\ \ by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /PractitionerRole/{id}/_history/{version_id}: get: tags: - PractitionerRole summary: "vread-instance: Read PractitionerRole instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: date in: query description: The period during which the practitioner is authorized to perform in these role(s) style: simple - name: specialty in: query description: The practitioner has this specialty at an organization style: simple - name: role in: query description: The practitioner can perform this role at for the organization style: simple - name: resource-placeholder in: query description: "Search for resources of type [PractitionerRole] populated with\ \ the resource-placeholder extension" style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the practitioner with this role style: simple - name: telecom in: query description: The value in any kind of contact style: simple - name: email in: query description: A value in an email contact style: simple - name: identifier in: query description: A practitioner's Identifier - 2022-07-27 reload style: simple - name: practitioner in: query description: Practitioner that is able to provide the defined services for the organization style: simple - name: identifier-system-prn-unique in: query style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: active in: query description: Whether this practitioner role record is in active use style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: phone in: query description: A value in a phone contact style: simple - name: service in: query description: The list of healthcare services that this worker provides for this role's Organization/Location(s) style: simple - name: organization in: query description: The identity of the organization the practitioner represents / acts on behalf of style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: location in: query description: One of the locations at which this practitioner provides care style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: identifier-system-prn in: query description: A practitioner role identifier with system PRN style: simple 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: - PractitionerRole summary: "create-type: Create a new PractitionerRole instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "PractitionerRole" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /PractitionerRole/_history: get: tags: - PractitionerRole summary: "type-history: Fetch the resource change history for all resources\ \ of type PractitionerRole" 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}/_history: get: tags: - PractitionerRole summary: "instance-history: Fetch the resource change history for all resources\ \ of type PractitionerRole" 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/$validate: get: tags: - PractitionerRole parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - PractitionerRole parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - PractitionerRole description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - PractitionerRole description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - PractitionerRole description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - PractitionerRole description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - PractitionerRole requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - PractitionerRole 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - PractitionerRole description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - PractitionerRole 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": "path", "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' /PractitionerRole/{id}/$binary-access-read: get: tags: - PractitionerRole parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - PractitionerRole summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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' put: tags: - Procedure summary: "update-instance: Update an existing Procedure instance, or create\ \ using a client-assigned ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Procedure" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' delete: tags: - Procedure summary: "instance-delete: Perform a logical delete on a resource 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' patch: tags: - Procedure summary: "instance-patch: Patch a resource instance of type Procedure by ID" 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: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Procedure/{id}/_history/{version_id}: get: tags: - Procedure summary: "vread-instance: Read Procedure instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: "1" 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: date in: query description: When the procedure was performed style: simple - name: code in: query description: A code to identify a procedure style: simple - name: resource-placeholder in: query description: "Search for resources of type [Procedure] populated with the\ \ resource-placeholder extension" style: simple - name: subject in: query description: Search by subject style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range style: simple - name: part-of in: query description: Part of referenced event style: simple - name: reason-code in: query description: Coded reason procedure performed style: simple - name: based-on in: query description: A request for this procedure style: simple - name: patient in: query description: Search by subject - a patient style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: identifier in: query description: A unique identifier for a procedure style: simple - name: performer in: query description: The reference to the practitioner style: simple - name: _security in: query description: Search for resources which have the given security labels style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: _profile in: query description: Search for resources which have the given profile style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _tag in: query description: Search for resources which have the given tag style: simple - name: reason-reference in: query description: The justification that the procedure was performed style: simple - name: location in: query description: Where the procedure happened style: simple - name: _source in: query description: Search for resources which have the given source value (Resource.meta.source) style: simple - name: _id in: query description: The ID of the resource style: simple - name: category in: query description: Classification of the procedure style: simple - name: _content in: query description: Search the contents of the resource's data using a fulltext search style: simple - name: _text in: query description: Search the contents of the resource's narrative using a fulltext search style: simple - name: status in: query description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown style: simple 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: - Procedure summary: "create-type: Create a new Procedure instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Procedure" } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' 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' /Procedure/_history: get: tags: - Procedure summary: "type-history: Fetch the resource change history for all resources\ \ of type Procedure" 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}/_history: get: tags: - Procedure summary: "instance-history: Fetch the resource change history for all resources\ \ of type Procedure" 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/$validate: get: tags: - Procedure parameters: - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$validate: get: tags: - Procedure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: resource in: query required: false style: simple - name: mode in: query required: false style: simple - name: profile in: query required: false style: simple 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}/$meta-delete: post: tags: - Procedure description: "Delete tags, profiles, and/or security labels from a resource" 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": "meta" }, { "name": "return" } ] } 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}/$meta-add: post: tags: - Procedure description: "Add tags, profiles, and/or security labels to a resource" 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": "meta" }, { "name": "return" } ] } 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/$meta: get: tags: - Procedure description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: return in: query required: false style: simple 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}/$meta: get: tags: - Procedure description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: return in: query required: false style: simple 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/$expunge: post: tags: - Procedure requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$expunge: post: tags: - Procedure 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": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false }, { "name": "count" } ] } 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}/$graphql: get: tags: - Procedure description: "This operation invokes a GraphQL expression for fetching an joining\ \ a graph of resources, returning them in a custom format." 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/{id}/$binary-access-write: post: tags: - Procedure 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": "path", "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' /Procedure/{id}/$binary-access-read: get: tags: - Procedure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: path in: query required: true style: simple 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}/$diff: get: tags: - Procedure summary: Comparte two resources or two versions of a single resource description: "This operation examines two resource versions (can be two versions\ \ of the same resource, or two different resources) and generates a FHIR Patch\ \ document showing the differences." parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: "123" - name: from in: query description: The resource ID and version to diff from required: true style: simple example: Patient/example/version/1 - name: to in: query description: The resource ID and version to diff to required: true style: simple example: Patient/example/version/2 - name: includeMeta in: query description: Should differences in the Resource.meta element be included in the diff required: false style: simple example: "false" - name: fromVersion in: query description: The resource ID and version to diff from required: false style: simple example: Patient/example/version/1 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 securitySchemes: openId: type: openIdConnect openIdConnectUrl: https://api-ext.amerihealthcaritas.com/6100/patient-api/.well-known/smart-configuration