openapi: 3.0.1 info: title: HAPI FHIR Server contact: {} version: 6.6.0 servers: - url: https://fhir.devoted.com/fhir description: HAPI FHIR Server tags: - name: System Level Operations description: Server-level operations - name: CodeSystem description: The CodeSystem FHIR resource type - name: HealthcareService description: The HealthcareService 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: MedicationKnowledge description: The MedicationKnowledge FHIR resource type - name: OperationDefinition description: The OperationDefinition FHIR resource type - name: Organization description: The Organization FHIR resource type - name: OrganizationAffiliation description: The OrganizationAffiliation FHIR resource type - name: Practitioner description: The Practitioner FHIR resource type - name: PractitionerRole description: The PractitionerRole FHIR resource type - name: SearchParameter description: The SearchParameter FHIR resource type - name: StructureDefinition description: The StructureDefinition FHIR resource type - name: Subscription description: The Subscription FHIR resource type - name: ValueSet description: The ValueSet 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /_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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$reindex: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "url", "valueString": "example" }, { "name": "reindexSearchParameters", "valueCode": "example" }, { "name": "optimizeStorage", "valueCode": "example" }, { "name": "optimisticLock", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$meta: get: tags: - System Level Operations description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - System Level Operations description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$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: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "type", "valueCode": "example" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$expunge: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$reindex-terminology: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$upload-external-code-system: post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "system", "valueUri": "example" }, { "name": "file" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$apply-codesystem-delta-remove: post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "system", "valueUri": "example" }, { "name": "file" }, { "name": "codeSystem" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$apply-codesystem-delta-add: post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "system", "valueUri": "example" }, { "name": "file" }, { "name": "codeSystem" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService: get: tags: - HealthcareService summary: "search-type: Search for HealthcareService instances" description: This is a search type parameters: - 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: _lastUpdated in: query description: When the resource version last changed style: simple - name: service-type in: query description: The type of service provided by this healthcare service style: simple - name: _security in: query description: Security Labels applied to this resource 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: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to electronic services operated for the healthcare service style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: coverage-area in: query description: Location(s) service is intended for/available to style: simple - name: _tag in: query description: Tags applied to this resource 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: name in: query description: A portion of the Healthcare service name style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The location of the Healthcare Service style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/_search: get: tags: - HealthcareService summary: "search-type: Search for HealthcareService instances" description: This is a search type parameters: - 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: _lastUpdated in: query description: When the resource version last changed style: simple - name: service-type in: query description: The type of service provided by this healthcare service style: simple - name: _security in: query description: Security Labels applied to this resource 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: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to electronic services operated for the healthcare service style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: coverage-area in: query description: Location(s) service is intended for/available to style: simple - name: _tag in: query description: Tags applied to this resource 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: name in: query description: A portion of the Healthcare service name style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The location of the Healthcare Service style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/$validate: get: tags: - HealthcareService parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - HealthcareService requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "HealthcareService", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - HealthcareService parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "HealthcareService", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/$meta: get: tags: - HealthcareService description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - HealthcareService description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/$expunge: post: tags: - HealthcareService requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: _lastUpdated in: query description: Accesses the last updated date of an InsurancePlan style: simple - name: type in: query description: Accesses the Type of an InsurancePlan 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: coverage-area in: query description: Search InsurancePlan by coverage location. style: simple - name: address-city in: query description: A city specified in an address style: simple - name: identifier in: query description: Accesses the business identifier of an InsurancePlan style: simple - name: period in: query description: Accesses the active period of an InsurancePlan 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: Security Labels applied to this resource style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: formulary-coverage in: query description: Accesses the Coverage Formulary Reference of an InsurancePlan style: simple - name: coverage-type in: query description: Accesses the coverage type of an InsurancePlan style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: Accesses the name of an InsurancePlan style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Accesses the status of an InsurancePlan style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/_search: 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: _lastUpdated in: query description: Accesses the last updated date of an InsurancePlan style: simple - name: type in: query description: Accesses the Type of an InsurancePlan 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: coverage-area in: query description: Search InsurancePlan by coverage location. style: simple - name: address-city in: query description: A city specified in an address style: simple - name: identifier in: query description: Accesses the business identifier of an InsurancePlan style: simple - name: period in: query description: Accesses the active period of an InsurancePlan 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: Security Labels applied to this resource style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: formulary-coverage in: query description: Accesses the Coverage Formulary Reference of an InsurancePlan style: simple - name: coverage-type in: query description: Accesses the coverage type of an InsurancePlan style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: Accesses the name of an InsurancePlan style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Accesses the status of an InsurancePlan style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/$validate: get: tags: - InsurancePlan parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - InsurancePlan requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "InsurancePlan", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - InsurancePlan parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "InsurancePlan", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/$meta: get: tags: - InsurancePlan description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - InsurancePlan description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/$expunge: post: tags: - InsurancePlan requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List: get: tags: - List summary: "search-type: Search for List instances" description: This is a search type parameters: - name: date in: query description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\ \ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\ \ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\ \ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\ \ was documented\r\n* [Composition](composition.html): Composition editing\ \ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\ \n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\ \ of the report\r\n* [Encounter](encounter.html): A date within the period\ \ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\ \ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\ \ When history was recorded or last updated\r\n* [Flag](flag.html): Time\ \ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\ \ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\ \n* [Observation](observation.html): Obtained date/time. If the obtained\ \ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\ \ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\ \ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\ \ the request was made" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\ \ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\ \ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\ \n* [Composition](composition.html): Version-independent identifier for\ \ the Composition\r\n* [Condition](condition.html): A unique identifier\ \ of the condition record\r\n* [Consent](consent.html): Identifier for this\ \ record (external references)\r\n* [DetectedIssue](detectedissue.html):\ \ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\ \ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\ \ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\ \ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\ \ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\ \ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\ \ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\ \ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\ \ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\ \ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\ \ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\ \ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\ \ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\ \ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\ \ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\ \ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\ \ The unique id for a particular observation\r\n* [Procedure](procedure.html):\ \ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\ \ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\ \ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\ \ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\ \ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\ \ Return prescriptions with this external identifier" style: simple - name: empty-reason in: query description: Why list is empty style: simple - name: item in: query description: Actual entry style: simple - name: code in: query description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\ \ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\ \ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\ \ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\ \ The code for the report, as opposed to codes for the atomic results, which\ \ are the names on the observation resource referred to from the result\r\ \n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\ \ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\ \ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\ \ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\ \ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\ \ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\ \ Return statements of this medication code\r\n* [Observation](observation.html):\ \ The code of the observation type\r\n* [Procedure](procedure.html): A code\ \ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\ \ is being requested/ordered" style: simple - name: notes in: query description: The annotation - text content (as markdown) style: simple - name: subject in: query description: If all resources have the same subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\ \ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\ \ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\ \ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\ \ Context of the document content\r\n* [Flag](flag.html): Alert relevant\ \ during encounter\r\n* [List](list.html): Context in which list created\r\ \n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\ \ this encounter identifier\r\n* [Observation](observation.html): Encounter\ \ related to the observation\r\n* [Procedure](procedure.html): Encounter\ \ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\ \ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\ \ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\ \ Return prescriptions with this encounter identifier" 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: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\ \ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\ \ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\ \ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\ \n* [Composition](composition.html): Who and/or what the composition is\ \ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\ \ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\ \ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\ \ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\ \ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\ \ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\ \ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\ \ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\ \ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\ \ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\ \ The identity of a subject to list family member history items for\r\n\ * [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\ \ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\ \ Who the study is about\r\n* [Immunization](immunization.html): The patient\ \ for the vaccination record\r\n* [List](list.html): If all resources have\ \ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\ \ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\ \ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\ \ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\ \ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\ \ The identity of the person who requires the diet, formula or nutritional\ \ supplement\r\n* [Observation](observation.html): The subject that the\ \ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\ \ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\ \ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\ \ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\ \ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\ \ The identity of a patient to list dispenses for" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/_search: get: tags: - List summary: "search-type: Search for List instances" description: This is a search type parameters: - name: date in: query description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\ \ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\ \ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\ \ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\ \ was documented\r\n* [Composition](composition.html): Composition editing\ \ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\ \n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\ \ of the report\r\n* [Encounter](encounter.html): A date within the period\ \ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\ \ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\ \ When history was recorded or last updated\r\n* [Flag](flag.html): Time\ \ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\ \ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\ \n* [Observation](observation.html): Obtained date/time. If the obtained\ \ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\ \ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\ \ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\ \ the request was made" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\ \ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\ \ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\ \n* [Composition](composition.html): Version-independent identifier for\ \ the Composition\r\n* [Condition](condition.html): A unique identifier\ \ of the condition record\r\n* [Consent](consent.html): Identifier for this\ \ record (external references)\r\n* [DetectedIssue](detectedissue.html):\ \ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\ \ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\ \ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\ \ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\ \ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\ \ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\ \ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\ \ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\ \ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\ \ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\ \ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\ \ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\ \ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\ \ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\ \ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\ \ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\ \ The unique id for a particular observation\r\n* [Procedure](procedure.html):\ \ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\ \ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\ \ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\ \ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\ \ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\ \ Return prescriptions with this external identifier" style: simple - name: empty-reason in: query description: Why list is empty style: simple - name: item in: query description: Actual entry style: simple - name: code in: query description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\ \ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\ \ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\ \ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\ \ The code for the report, as opposed to codes for the atomic results, which\ \ are the names on the observation resource referred to from the result\r\ \n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\ \ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\ \ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\ \ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\ \ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\ \ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\ \ Return statements of this medication code\r\n* [Observation](observation.html):\ \ The code of the observation type\r\n* [Procedure](procedure.html): A code\ \ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\ \ is being requested/ordered" style: simple - name: notes in: query description: The annotation - text content (as markdown) style: simple - name: subject in: query description: If all resources have the same subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\ \ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\ \ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\ \ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\ \ Context of the document content\r\n* [Flag](flag.html): Alert relevant\ \ during encounter\r\n* [List](list.html): Context in which list created\r\ \n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\ \ this encounter identifier\r\n* [Observation](observation.html): Encounter\ \ related to the observation\r\n* [Procedure](procedure.html): Encounter\ \ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\ \ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\ \ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\ \ Return prescriptions with this encounter identifier" 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: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\ \ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\ \ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\ \ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\ \n* [Composition](composition.html): Who and/or what the composition is\ \ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\ \ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\ \ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\ \ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\ \ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\ \ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\ \ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\ \ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\ \ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\ \ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\ \ The identity of a subject to list family member history items for\r\n\ * [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\ \ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\ \ Who the study is about\r\n* [Immunization](immunization.html): The patient\ \ for the vaccination record\r\n* [List](list.html): If all resources have\ \ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\ \ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\ \ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\ \ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\ \ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\ \ The identity of the person who requires the diet, formula or nutritional\ \ supplement\r\n* [Observation](observation.html): The subject that the\ \ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\ \ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\ \ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\ \ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\ \ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\ \ The identity of a patient to list dispenses for" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/$validate: get: tags: - List parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - List requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "List", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - List parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "List", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/$meta: get: tags: - List description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - List description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/$expunge: post: tags: - List requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _lastUpdated in: query description: When the resource version last changed 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: 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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: identifier in: query description: An identifier for the location style: simple - name: partof in: query description: A location of which this location is a part style: simple - name: address in: query description: |- A (part of the) address of the location
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: address-postalcode in: query description: |- A postal code specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource 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: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: |- A portion of the location's name or alias
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/_search: 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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _lastUpdated in: query description: When the resource version last changed 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: 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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: identifier in: query description: An identifier for the location style: simple - name: partof in: query description: A location of which this location is a part style: simple - name: address in: query description: |- A (part of the) address of the location
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: address-postalcode in: query description: |- A postal code specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource 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: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: |- A portion of the location's name or alias
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/$validate: get: tags: - Location parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "Location", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "Location", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/$meta: get: tags: - Location description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/$expunge: post: tags: - Location requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge: get: tags: - MedicationKnowledge summary: "search-type: Search for MedicationKnowledge instances" description: This is a search type parameters: - name: code in: query description: Accesses the status of a FormularyDrug style: simple - name: ingredient in: query description: Medication(s) or substance(s) contained in the medication style: simple - name: doseform in: query description: Accesses the dose form of a FormularyDrug style: simple - name: _lastUpdated in: query description: Accesses the last updated date of a FormularyItem style: simple - name: _security in: query description: Security Labels applied to this resource 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: _filter in: query description: Search the contents of the resource's data using a filter 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: drug-name in: query description: Accesses the Drug Name of a FormularyDrug style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: monitoring-program-name in: query description: Name of the reviewing program style: simple - name: monograph in: query description: Associated documentation about the medication style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: monitoring-program-type in: query description: Type of program under which the medication is monitored style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Accesses the status of a FormularyDrug style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/_search: get: tags: - MedicationKnowledge summary: "search-type: Search for MedicationKnowledge instances" description: This is a search type parameters: - name: code in: query description: Accesses the status of a FormularyDrug style: simple - name: ingredient in: query description: Medication(s) or substance(s) contained in the medication style: simple - name: doseform in: query description: Accesses the dose form of a FormularyDrug style: simple - name: _lastUpdated in: query description: Accesses the last updated date of a FormularyItem style: simple - name: _security in: query description: Security Labels applied to this resource 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: _filter in: query description: Search the contents of the resource's data using a filter 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: drug-name in: query description: Accesses the Drug Name of a FormularyDrug style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: monitoring-program-name in: query description: Name of the reviewing program style: simple - name: monograph in: query description: Associated documentation about the medication style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: monitoring-program-type in: query description: Type of program under which the medication is monitored style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Accesses the status of a FormularyDrug style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/$validate: get: tags: - MedicationKnowledge parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationKnowledge requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "MedicationKnowledge", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationKnowledge parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "MedicationKnowledge", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/$meta: get: tags: - MedicationKnowledge description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationKnowledge description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/$expunge: post: tags: - MedicationKnowledge requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}: get: tags: - OperationDefinition summary: "read-instance: Read OperationDefinition instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null put: tags: - OperationDefinition summary: "update-instance: Update an existing OperationDefinition 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "OperationDefinition" } 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null delete: tags: - OperationDefinition 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null patch: tags: - OperationDefinition summary: "instance-patch: Patch a resource instance of type OperationDefinition\ \ by ID" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/_history/{version_id}: get: tags: - OperationDefinition summary: "vread-instance: Read OperationDefinition instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition: get: tags: - OperationDefinition summary: "search-type: Search for OperationDefinition instances" description: This is a search type parameters: - name: date in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\ \ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\ \ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\ \ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\ \ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\ \ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\ \ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\ \ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\ \ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\ \ The structure definition publication date\r\n* [StructureMap](structuremap.html):\ \ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\ \ The value set publication date" style: simple - name: code in: query description: Name used to invoke the operation style: simple - name: instance in: query description: Invoke on an instance? style: simple - name: context-type-value in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and value assigned to the capability statement\r\n\ * [CodeSystem](codesystem.html): A use context type and value assigned to\ \ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context type and value assigned to the compartment definition\r\n\ * [ConceptMap](conceptmap.html): A use context type and value assigned to\ \ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\ \ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and value assigned to the implementation guide\r\n\ * [MessageDefinition](messagedefinition.html): A use context type and value\ \ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context type and value assigned to the operation definition\r\n\ * [SearchParameter](searchparameter.html): A use context type and value\ \ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and value assigned to the structure definition\r\n\ * [StructureMap](structuremap.html): A use context type and value assigned\ \ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context type and value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and value assigned to\ \ the value set" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\ \ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\ \ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Intended jurisdiction for the value set" style: simple - name: description in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The description of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The description of the value set" style: simple - name: context-type in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A type of use context assigned to the value set" style: simple - name: title in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\ \ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\ \ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\ \ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The human-friendly name of the value set" style: simple - name: type in: query description: Invoke at the type level? style: simple - name: context-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A quantity- or range-valued use context assigned to the capability statement\r\ \n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\ \ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A quantity- or range-valued use context assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\ \ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A quantity- or range-valued use context assigned to the graph definition\r\ \n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\ \ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A quantity- or range-valued use context assigned to the message definition\r\ \n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\ \ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A quantity- or range-valued use context assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A quantity- or range-valued\ \ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A quantity- or range-valued use context assigned to the structure definition\r\ \n* [StructureMap](structuremap.html): A quantity- or range-valued use context\ \ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A quantity- or range-valued use context assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\ \ to the value set" style: simple - name: output-profile in: query description: Validation information for out parameters style: simple - name: context in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A use context assigned to the value set" style: simple - name: context-type-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ capability statement\r\n* [CodeSystem](codesystem.html): A use context\ \ type and quantity- or range-based value assigned to the code system\r\n\ * [CompartmentDefinition](compartmentdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\ \ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ message definition\r\n* [NamingSystem](namingsystem.html): A use context\ \ type and quantity- or range-based value assigned to the naming system\r\ \n* [OperationDefinition](operationdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A use context type and quantity-\ \ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ structure definition\r\n* [StructureMap](structuremap.html): A use context\ \ type and quantity- or range-based value assigned to the structure map\r\ \n* [TerminologyCapabilities](terminologycapabilities.html): A use context\ \ type and quantity- or range-based value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and quantity- or range-based\ \ value assigned to the value set" style: simple - name: kind in: query description: operation | query style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The business version of the value set" style: simple - name: url in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\ \ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The uri that identifies the value set" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: input-profile in: query description: Validation information for in parameters style: simple - name: system in: query description: Invoke at the system level? style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Computationally friendly name of the value set" style: simple - name: publisher in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Name of the publisher of the value set" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The current status of the value set" style: simple - name: base in: query description: Marks this as a profile of the base style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationDefinition summary: "create-type: Create a new OperationDefinition instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "OperationDefinition" } 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/_history: get: tags: - OperationDefinition summary: "type-history: Fetch the resource change history for all resources\ \ of type OperationDefinition" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/_history: get: tags: - OperationDefinition summary: "instance-history: Fetch the resource change history for all resources\ \ of type OperationDefinition" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/_search: get: tags: - OperationDefinition summary: "search-type: Search for OperationDefinition instances" description: This is a search type parameters: - name: date in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\ \ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\ \ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\ \ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\ \ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\ \ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\ \ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\ \ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\ \ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\ \ The structure definition publication date\r\n* [StructureMap](structuremap.html):\ \ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\ \ The value set publication date" style: simple - name: code in: query description: Name used to invoke the operation style: simple - name: instance in: query description: Invoke on an instance? style: simple - name: context-type-value in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and value assigned to the capability statement\r\n\ * [CodeSystem](codesystem.html): A use context type and value assigned to\ \ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context type and value assigned to the compartment definition\r\n\ * [ConceptMap](conceptmap.html): A use context type and value assigned to\ \ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\ \ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and value assigned to the implementation guide\r\n\ * [MessageDefinition](messagedefinition.html): A use context type and value\ \ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context type and value assigned to the operation definition\r\n\ * [SearchParameter](searchparameter.html): A use context type and value\ \ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and value assigned to the structure definition\r\n\ * [StructureMap](structuremap.html): A use context type and value assigned\ \ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context type and value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and value assigned to\ \ the value set" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\ \ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\ \ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Intended jurisdiction for the value set" style: simple - name: description in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The description of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The description of the value set" style: simple - name: context-type in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A type of use context assigned to the value set" style: simple - name: title in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\ \ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\ \ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\ \ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The human-friendly name of the value set" style: simple - name: type in: query description: Invoke at the type level? style: simple - name: context-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A quantity- or range-valued use context assigned to the capability statement\r\ \n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\ \ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A quantity- or range-valued use context assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\ \ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A quantity- or range-valued use context assigned to the graph definition\r\ \n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\ \ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A quantity- or range-valued use context assigned to the message definition\r\ \n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\ \ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A quantity- or range-valued use context assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A quantity- or range-valued\ \ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A quantity- or range-valued use context assigned to the structure definition\r\ \n* [StructureMap](structuremap.html): A quantity- or range-valued use context\ \ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A quantity- or range-valued use context assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\ \ to the value set" style: simple - name: output-profile in: query description: Validation information for out parameters style: simple - name: context in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A use context assigned to the value set" style: simple - name: context-type-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ capability statement\r\n* [CodeSystem](codesystem.html): A use context\ \ type and quantity- or range-based value assigned to the code system\r\n\ * [CompartmentDefinition](compartmentdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\ \ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ message definition\r\n* [NamingSystem](namingsystem.html): A use context\ \ type and quantity- or range-based value assigned to the naming system\r\ \n* [OperationDefinition](operationdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A use context type and quantity-\ \ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ structure definition\r\n* [StructureMap](structuremap.html): A use context\ \ type and quantity- or range-based value assigned to the structure map\r\ \n* [TerminologyCapabilities](terminologycapabilities.html): A use context\ \ type and quantity- or range-based value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and quantity- or range-based\ \ value assigned to the value set" style: simple - name: kind in: query description: operation | query style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The business version of the value set" style: simple - name: url in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\ \ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The uri that identifies the value set" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: input-profile in: query description: Validation information for in parameters style: simple - name: system in: query description: Invoke at the system level? style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Computationally friendly name of the value set" style: simple - name: publisher in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Name of the publisher of the value set" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The current status of the value set" style: simple - name: base in: query description: Marks this as a profile of the base style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/$validate: get: tags: - OperationDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "OperationDefinition", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$validate: get: tags: - OperationDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "OperationDefinition", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$meta-delete: post: tags: - OperationDefinition 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$meta-add: post: tags: - OperationDefinition 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/$meta: get: tags: - OperationDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$meta: get: tags: - OperationDefinition 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationDefinition 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/$expunge: post: tags: - OperationDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$expunge: post: tags: - OperationDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization: get: tags: - Organization summary: "search-type: Search for Organization instances" description: This is a search type parameters: - name: identifier in: query description: Any identifier for the organization (not the accreditation issuer's identifier) style: simple - name: partof in: query description: An organization of which this organization forms a part 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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: address-state in: query description: A state specified in an address style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Is the Organization record active style: simple - name: type in: query description: A code for the type of organization style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: address-country in: query description: A country specified in an address style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter 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: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target 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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: address-city in: query description: A city specified in an address style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/_search: get: tags: - Organization summary: "search-type: Search for Organization instances" description: This is a search type parameters: - name: identifier in: query description: Any identifier for the organization (not the accreditation issuer's identifier) style: simple - name: partof in: query description: An organization of which this organization forms a part 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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: address-state in: query description: A state specified in an address style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Is the Organization record active style: simple - name: type in: query description: A code for the type of organization style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: address-country in: query description: A country specified in an address style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter 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: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target 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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: address-city in: query description: A city specified in an address style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/$validate: get: tags: - Organization parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Organization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "Organization", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Organization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "Organization", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/$meta: get: tags: - Organization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Organization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/$expunge: post: tags: - Organization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation: get: tags: - OrganizationAffiliation summary: "search-type: Search for OrganizationAffiliation instances" description: This is a search type parameters: - name: date in: query description: The period during which the participatingOrganization is affiliated with the primary organization style: simple - name: identifier in: query description: An organization affiliation's Identifier 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: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource 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: 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: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to 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: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: participating-organization in: query description: The organization that provides services to the primary organization style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The location(s) at which the role occurs style: simple - name: telecom in: query description: The value in any kind of contact style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: A value in an email contact style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/_search: get: tags: - OrganizationAffiliation summary: "search-type: Search for OrganizationAffiliation instances" description: This is a search type parameters: - name: date in: query description: The period during which the participatingOrganization is affiliated with the primary organization style: simple - name: identifier in: query description: An organization affiliation's Identifier 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: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource 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: 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: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to 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: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: participating-organization in: query description: The organization that provides services to the primary organization style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The location(s) at which the role occurs style: simple - name: telecom in: query description: The value in any kind of contact style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: A value in an email contact style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/$validate: get: tags: - OrganizationAffiliation parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OrganizationAffiliation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "OrganizationAffiliation", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OrganizationAffiliation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "OrganizationAffiliation", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/$meta: get: tags: - OrganizationAffiliation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OrganizationAffiliation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/$expunge: post: tags: - OrganizationAffiliation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner: get: tags: - Practitioner summary: "search-type: Search for Practitioner instances" description: This is a search type parameters: - name: address-state in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\ \ specified in an address\r\n* [Person](person.html): A state specified\ \ in an address\r\n* [Practitioner](practitioner.html): A state specified\ \ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\ \ in an address" style: simple - name: gender in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\ \ of the patient\r\n* [Person](person.html): The gender of the person\r\n\ * [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\ \ Gender of the related person" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: address-country in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\ \ specified in an address\r\n* [Person](person.html): A country specified\ \ in an address\r\n* [Practitioner](practitioner.html): A country specified\ \ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\ \ in an address" style: simple - name: phonetic in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\ \ of either family or given name using some kind of phonetic matching algorithm\r\ \n* [Person](person.html): A portion of name using some kind of phonetic\ \ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\ \ either family or given name using some kind of phonetic matching algorithm\r\ \n* [RelatedPerson](relatedperson.html): A portion of name using some kind\ \ of phonetic matching algorithm" style: simple - name: telecom in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\ \ in any kind of telecom details of the patient\r\n* [Person](person.html):\ \ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\ \ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\ \ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\ \ The value in any kind of contact" style: simple - name: address-city in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\ \ specified in an address\r\n* [Person](person.html): A city specified in\ \ an address\r\n* [Practitioner](practitioner.html): A city specified in\ \ an address\r\n* [RelatedPerson](relatedperson.html): 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: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\ \ in an email contact\r\n* [Person](person.html): A value in an email contact\r\ \n* [Practitioner](practitioner.html): A value in an email contact\r\n*\ \ [PractitionerRole](practitionerrole.html): A value in an email contact\r\ \n* [RelatedPerson](relatedperson.html): A value in an email contact" style: simple - name: given in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\ \ of the given name of the patient\r\n* [Practitioner](practitioner.html):\ \ A portion of the given name" style: simple - name: identifier in: query description: |- A practitioner's Identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: address in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\ \n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html):\ \ 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\r\n* [RelatedPerson](relatedperson.html): 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: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether the practitioner record is active style: simple - name: address-postalcode in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\ \ specified in an address\r\n* [Person](person.html): A postal code specified\ \ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\ \ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\ \ specified in an address" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\ \ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\ \n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\ \ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\ \ value in a phone contact" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\ \ code specified in an address\r\n* [Person](person.html): A use code specified\ \ in an address\r\n* [Practitioner](practitioner.html): A use code specified\ \ in an address\r\n* [RelatedPerson](relatedperson.html): 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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: family in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\ \ of the family name of the patient\r\n* [Practitioner](practitioner.html):\ \ A portion of the family name" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/_search: get: tags: - Practitioner summary: "search-type: Search for Practitioner instances" description: This is a search type parameters: - name: address-state in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\ \ specified in an address\r\n* [Person](person.html): A state specified\ \ in an address\r\n* [Practitioner](practitioner.html): A state specified\ \ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\ \ in an address" style: simple - name: gender in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\ \ of the patient\r\n* [Person](person.html): The gender of the person\r\n\ * [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\ \ Gender of the related person" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: address-country in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\ \ specified in an address\r\n* [Person](person.html): A country specified\ \ in an address\r\n* [Practitioner](practitioner.html): A country specified\ \ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\ \ in an address" style: simple - name: phonetic in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\ \ of either family or given name using some kind of phonetic matching algorithm\r\ \n* [Person](person.html): A portion of name using some kind of phonetic\ \ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\ \ either family or given name using some kind of phonetic matching algorithm\r\ \n* [RelatedPerson](relatedperson.html): A portion of name using some kind\ \ of phonetic matching algorithm" style: simple - name: telecom in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\ \ in any kind of telecom details of the patient\r\n* [Person](person.html):\ \ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\ \ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\ \ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\ \ The value in any kind of contact" style: simple - name: address-city in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\ \ specified in an address\r\n* [Person](person.html): A city specified in\ \ an address\r\n* [Practitioner](practitioner.html): A city specified in\ \ an address\r\n* [RelatedPerson](relatedperson.html): 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: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\ \ in an email contact\r\n* [Person](person.html): A value in an email contact\r\ \n* [Practitioner](practitioner.html): A value in an email contact\r\n*\ \ [PractitionerRole](practitionerrole.html): A value in an email contact\r\ \n* [RelatedPerson](relatedperson.html): A value in an email contact" style: simple - name: given in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\ \ of the given name of the patient\r\n* [Practitioner](practitioner.html):\ \ A portion of the given name" style: simple - name: identifier in: query description: |- A practitioner's Identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: address in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\ \n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html):\ \ 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\r\n* [RelatedPerson](relatedperson.html): 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: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether the practitioner record is active style: simple - name: address-postalcode in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\ \ specified in an address\r\n* [Person](person.html): A postal code specified\ \ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\ \ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\ \ specified in an address" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\ \ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\ \n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\ \ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\ \ value in a phone contact" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\ \ code specified in an address\r\n* [Person](person.html): A use code specified\ \ in an address\r\n* [Practitioner](practitioner.html): A use code specified\ \ in an address\r\n* [RelatedPerson](relatedperson.html): 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
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: family in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\ \ of the family name of the patient\r\n* [Practitioner](practitioner.html):\ \ A portion of the family name" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/$validate: get: tags: - Practitioner parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Practitioner requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "Practitioner", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Practitioner parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "Practitioner", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/$meta: get: tags: - Practitioner description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Practitioner description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/$expunge: post: tags: - Practitioner requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: identifier in: query description: A practitioner's Identifier style: simple - name: specialty in: query description: |- The practitioner has this specialty at an organization
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: role in: query description: The practitioner can perform this role at for the organization style: simple - name: practitioner in: query description: |- Practitioner that is able to provide the defined services for the organization
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether this practitioner role record is in active use style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the practitioner with this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\ \ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\ \n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\ \ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): 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: _tag in: query description: Tags applied to this resource 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: _source in: query description: Identifies where the resource comes from style: simple - name: telecom in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\ \ in any kind of telecom details of the patient\r\n* [Person](person.html):\ \ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\ \ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\ \ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\ \ The value in any kind of contact" style: simple - name: location in: query description: One of the locations at which this practitioner provides care style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\ \ in an email contact\r\n* [Person](person.html): A value in an email contact\r\ \n* [Practitioner](practitioner.html): A value in an email contact\r\n*\ \ [PractitionerRole](practitionerrole.html): A value in an email contact\r\ \n* [RelatedPerson](relatedperson.html): A value in an email contact" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/_search: 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: identifier in: query description: A practitioner's Identifier style: simple - name: specialty in: query description: |- The practitioner has this specialty at an organization
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: role in: query description: The practitioner can perform this role at for the organization style: simple - name: practitioner in: query description: |- Practitioner that is able to provide the defined services for the organization
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer expectations for these elements:
- multipleAnd
- multipleOr
- modifier
- comparator
- chain
style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether this practitioner role record is in active use style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the practitioner with this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\ \ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\ \n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\ \ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): 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: _tag in: query description: Tags applied to this resource 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: _source in: query description: Identifies where the resource comes from style: simple - name: telecom in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\ \ in any kind of telecom details of the patient\r\n* [Person](person.html):\ \ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\ \ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\ \ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\ \ The value in any kind of contact" style: simple - name: location in: query description: One of the locations at which this practitioner provides care style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\ \ in an email contact\r\n* [Person](person.html): A value in an email contact\r\ \n* [Practitioner](practitioner.html): A value in an email contact\r\n*\ \ [PractitionerRole](practitionerrole.html): A value in an email contact\r\ \n* [RelatedPerson](relatedperson.html): A value in an email contact" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/$validate: get: tags: - PractitionerRole parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "PractitionerRole", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "PractitionerRole", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/$meta: get: tags: - PractitionerRole description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/$expunge: post: tags: - PractitionerRole requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}: get: tags: - SearchParameter summary: "read-instance: Read SearchParameter instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null put: tags: - SearchParameter summary: "update-instance: Update an existing SearchParameter 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "SearchParameter" } 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null delete: tags: - SearchParameter 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null patch: tags: - SearchParameter summary: "instance-patch: Patch a resource instance of type SearchParameter\ \ by ID" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/_history/{version_id}: get: tags: - SearchParameter summary: "vread-instance: Read SearchParameter instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter: get: tags: - SearchParameter summary: "search-type: Search for SearchParameter instances" description: This is a search type parameters: - name: date in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\ \ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\ \ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\ \ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\ \ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\ \ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\ \ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\ \ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\ \ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\ \ The structure definition publication date\r\n* [StructureMap](structuremap.html):\ \ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\ \ The value set publication date" style: simple - name: code in: query description: Code used in URL style: simple - name: context-type-value in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and value assigned to the capability statement\r\n\ * [CodeSystem](codesystem.html): A use context type and value assigned to\ \ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context type and value assigned to the compartment definition\r\n\ * [ConceptMap](conceptmap.html): A use context type and value assigned to\ \ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\ \ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and value assigned to the implementation guide\r\n\ * [MessageDefinition](messagedefinition.html): A use context type and value\ \ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context type and value assigned to the operation definition\r\n\ * [SearchParameter](searchparameter.html): A use context type and value\ \ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and value assigned to the structure definition\r\n\ * [StructureMap](structuremap.html): A use context type and value assigned\ \ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context type and value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and value assigned to\ \ the value set" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\ \ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\ \ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Intended jurisdiction for the value set" style: simple - name: description in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The description of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The description of the value set" style: simple - name: derived-from in: query description: Original definition for the search parameter style: simple - name: context-type in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A type of use context assigned to the value set" style: simple - name: type in: query description: number | date | string | token | reference | composite | quantity | uri | special style: simple - name: context-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A quantity- or range-valued use context assigned to the capability statement\r\ \n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\ \ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A quantity- or range-valued use context assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\ \ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A quantity- or range-valued use context assigned to the graph definition\r\ \n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\ \ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A quantity- or range-valued use context assigned to the message definition\r\ \n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\ \ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A quantity- or range-valued use context assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A quantity- or range-valued\ \ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A quantity- or range-valued use context assigned to the structure definition\r\ \n* [StructureMap](structuremap.html): A quantity- or range-valued use context\ \ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A quantity- or range-valued use context assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\ \ to the value set" style: simple - name: context in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A use context assigned to the value set" style: simple - name: context-type-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ capability statement\r\n* [CodeSystem](codesystem.html): A use context\ \ type and quantity- or range-based value assigned to the code system\r\n\ * [CompartmentDefinition](compartmentdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\ \ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ message definition\r\n* [NamingSystem](namingsystem.html): A use context\ \ type and quantity- or range-based value assigned to the naming system\r\ \n* [OperationDefinition](operationdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A use context type and quantity-\ \ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ structure definition\r\n* [StructureMap](structuremap.html): A use context\ \ type and quantity- or range-based value assigned to the structure map\r\ \n* [TerminologyCapabilities](terminologycapabilities.html): A use context\ \ type and quantity- or range-based value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and quantity- or range-based\ \ value assigned to the value set" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The business version of the value set" style: simple - name: url in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\ \ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The uri that identifies the value set" style: simple - name: target in: query description: Types of resource (if a resource reference) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: component in: query description: Defines how the part works style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Computationally friendly name of the value set" style: simple - name: publisher in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Name of the publisher of the value set" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The current status of the value set" style: simple - name: base in: query description: The resource type(s) this search parameter applies to style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SearchParameter summary: "create-type: Create a new SearchParameter instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "SearchParameter" } 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/_history: get: tags: - SearchParameter summary: "type-history: Fetch the resource change history for all resources\ \ of type SearchParameter" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/_history: get: tags: - SearchParameter summary: "instance-history: Fetch the resource change history for all resources\ \ of type SearchParameter" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/_search: get: tags: - SearchParameter summary: "search-type: Search for SearchParameter instances" description: This is a search type parameters: - name: date in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\ \ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\ \ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\ \ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\ \ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\ \ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\ \ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\ \ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\ \ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\ \ The structure definition publication date\r\n* [StructureMap](structuremap.html):\ \ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\ \ The value set publication date" style: simple - name: code in: query description: Code used in URL style: simple - name: context-type-value in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and value assigned to the capability statement\r\n\ * [CodeSystem](codesystem.html): A use context type and value assigned to\ \ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context type and value assigned to the compartment definition\r\n\ * [ConceptMap](conceptmap.html): A use context type and value assigned to\ \ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\ \ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and value assigned to the implementation guide\r\n\ * [MessageDefinition](messagedefinition.html): A use context type and value\ \ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context type and value assigned to the operation definition\r\n\ * [SearchParameter](searchparameter.html): A use context type and value\ \ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and value assigned to the structure definition\r\n\ * [StructureMap](structuremap.html): A use context type and value assigned\ \ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context type and value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and value assigned to\ \ the value set" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\ \ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\ \ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Intended jurisdiction for the value set" style: simple - name: description in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The description of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The description of the value set" style: simple - name: derived-from in: query description: Original definition for the search parameter style: simple - name: context-type in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A type of use context assigned to the value set" style: simple - name: type in: query description: number | date | string | token | reference | composite | quantity | uri | special style: simple - name: context-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A quantity- or range-valued use context assigned to the capability statement\r\ \n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\ \ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A quantity- or range-valued use context assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\ \ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A quantity- or range-valued use context assigned to the graph definition\r\ \n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\ \ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A quantity- or range-valued use context assigned to the message definition\r\ \n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\ \ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A quantity- or range-valued use context assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A quantity- or range-valued\ \ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A quantity- or range-valued use context assigned to the structure definition\r\ \n* [StructureMap](structuremap.html): A quantity- or range-valued use context\ \ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A quantity- or range-valued use context assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\ \ to the value set" style: simple - name: context in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A use context assigned to the value set" style: simple - name: context-type-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ capability statement\r\n* [CodeSystem](codesystem.html): A use context\ \ type and quantity- or range-based value assigned to the code system\r\n\ * [CompartmentDefinition](compartmentdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\ \ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ message definition\r\n* [NamingSystem](namingsystem.html): A use context\ \ type and quantity- or range-based value assigned to the naming system\r\ \n* [OperationDefinition](operationdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A use context type and quantity-\ \ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ structure definition\r\n* [StructureMap](structuremap.html): A use context\ \ type and quantity- or range-based value assigned to the structure map\r\ \n* [TerminologyCapabilities](terminologycapabilities.html): A use context\ \ type and quantity- or range-based value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and quantity- or range-based\ \ value assigned to the value set" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The business version of the value set" style: simple - name: url in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\ \ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The uri that identifies the value set" style: simple - name: target in: query description: Types of resource (if a resource reference) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: component in: query description: Defines how the part works style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Computationally friendly name of the value set" style: simple - name: publisher in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Name of the publisher of the value set" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The current status of the value set" style: simple - name: base in: query description: The resource type(s) this search parameter applies to style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/$validate: get: tags: - SearchParameter parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SearchParameter requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "SearchParameter", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$validate: get: tags: - SearchParameter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SearchParameter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "SearchParameter", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$meta-delete: post: tags: - SearchParameter 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$meta-add: post: tags: - SearchParameter 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/$meta: get: tags: - SearchParameter description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SearchParameter description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$meta: get: tags: - SearchParameter 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SearchParameter 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/$expunge: post: tags: - SearchParameter requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$expunge: post: tags: - SearchParameter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}: get: tags: - StructureDefinition summary: "read-instance: Read StructureDefinition instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null put: tags: - StructureDefinition summary: "update-instance: Update an existing StructureDefinition 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "StructureDefinition" } 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null delete: tags: - StructureDefinition 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null patch: tags: - StructureDefinition summary: "instance-patch: Patch a resource instance of type StructureDefinition\ \ by ID" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/_history/{version_id}: get: tags: - StructureDefinition summary: "vread-instance: Read StructureDefinition instance with specific version" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition: get: tags: - StructureDefinition summary: "search-type: Search for StructureDefinition instances" description: This is a search type parameters: - name: date in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\ \ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\ \ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\ \ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\ \ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\ \ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\ \ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\ \ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\ \ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\ \ The structure definition publication date\r\n* [StructureMap](structuremap.html):\ \ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\ \ The value set publication date" style: simple - name: context-type-value in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and value assigned to the capability statement\r\n\ * [CodeSystem](codesystem.html): A use context type and value assigned to\ \ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context type and value assigned to the compartment definition\r\n\ * [ConceptMap](conceptmap.html): A use context type and value assigned to\ \ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\ \ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and value assigned to the implementation guide\r\n\ * [MessageDefinition](messagedefinition.html): A use context type and value\ \ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context type and value assigned to the operation definition\r\n\ * [SearchParameter](searchparameter.html): A use context type and value\ \ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and value assigned to the structure definition\r\n\ * [StructureMap](structuremap.html): A use context type and value assigned\ \ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context type and value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and value assigned to\ \ the value set" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\ \ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\ \ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Intended jurisdiction for the value set" style: simple - name: description in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The description of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The description of the value set" style: simple - name: context-type in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A type of use context assigned to the value set" style: simple - name: experimental in: query description: "For testing purposes, not real usage" style: simple - name: title in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\ \ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\ \ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\ \ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The human-friendly name of the value set" style: simple - name: type in: query description: Type defined or constrained by this structure style: simple - name: context-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A quantity- or range-valued use context assigned to the capability statement\r\ \n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\ \ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A quantity- or range-valued use context assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\ \ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A quantity- or range-valued use context assigned to the graph definition\r\ \n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\ \ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A quantity- or range-valued use context assigned to the message definition\r\ \n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\ \ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A quantity- or range-valued use context assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A quantity- or range-valued\ \ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A quantity- or range-valued use context assigned to the structure definition\r\ \n* [StructureMap](structuremap.html): A quantity- or range-valued use context\ \ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A quantity- or range-valued use context assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\ \ to the value set" style: simple - name: path in: query description: A path that is constrained in the StructureDefinition style: simple - name: context in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A use context assigned to the value set" style: simple - name: base-path in: query description: Path that identifies the base element style: simple - name: keyword in: query description: A code for the StructureDefinition style: simple - name: context-type-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ capability statement\r\n* [CodeSystem](codesystem.html): A use context\ \ type and quantity- or range-based value assigned to the code system\r\n\ * [CompartmentDefinition](compartmentdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\ \ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ message definition\r\n* [NamingSystem](namingsystem.html): A use context\ \ type and quantity- or range-based value assigned to the naming system\r\ \n* [OperationDefinition](operationdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A use context type and quantity-\ \ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ structure definition\r\n* [StructureMap](structuremap.html): A use context\ \ type and quantity- or range-based value assigned to the structure map\r\ \n* [TerminologyCapabilities](terminologycapabilities.html): A use context\ \ type and quantity- or range-based value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and quantity- or range-based\ \ value assigned to the value set" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\ \ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\ \ External identifier for the structure map\r\n* [ValueSet](valueset.html):\ \ External identifier for the value set" style: simple - name: valueset in: query description: A vocabulary binding reference style: simple - name: kind in: query description: primitive-type | complex-type | resource | logical style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: abstract in: query description: Whether the structure is abstract style: simple - name: version in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The business version of the value set" style: simple - name: url in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\ \ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The uri that identifies the value set" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: ext-context in: query description: "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Computationally friendly name of the value set" style: simple - name: publisher in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Name of the publisher of the value set" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: derivation in: query description: specialization | constraint - How relates to base definition style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The current status of the value set" style: simple - name: base in: query description: Definition that this type is constrained/specialized from style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition summary: "create-type: Create a new StructureDefinition instance" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "StructureDefinition" } 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/_history: get: tags: - StructureDefinition summary: "type-history: Fetch the resource change history for all resources\ \ of type StructureDefinition" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/_history: get: tags: - StructureDefinition summary: "instance-history: Fetch the resource change history for all resources\ \ of type StructureDefinition" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/_search: get: tags: - StructureDefinition summary: "search-type: Search for StructureDefinition instances" description: This is a search type parameters: - name: date in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\ \ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\ \ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\ \ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\ \ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\ \ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\ \ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\ \ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\ \ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\ \ The structure definition publication date\r\n* [StructureMap](structuremap.html):\ \ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\ \ The value set publication date" style: simple - name: context-type-value in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and value assigned to the capability statement\r\n\ * [CodeSystem](codesystem.html): A use context type and value assigned to\ \ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context type and value assigned to the compartment definition\r\n\ * [ConceptMap](conceptmap.html): A use context type and value assigned to\ \ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\ \ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and value assigned to the implementation guide\r\n\ * [MessageDefinition](messagedefinition.html): A use context type and value\ \ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context type and value assigned to the operation definition\r\n\ * [SearchParameter](searchparameter.html): A use context type and value\ \ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and value assigned to the structure definition\r\n\ * [StructureMap](structuremap.html): A use context type and value assigned\ \ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context type and value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and value assigned to\ \ the value set" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\ \ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\ \ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Intended jurisdiction for the value set" style: simple - name: description in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The description of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The description of the value set" style: simple - name: context-type in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A type of use context assigned to the value set" style: simple - name: experimental in: query description: "For testing purposes, not real usage" style: simple - name: title in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\ \ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\ \ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\ \ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The human-friendly name of the value set" style: simple - name: type in: query description: Type defined or constrained by this structure style: simple - name: context-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A quantity- or range-valued use context assigned to the capability statement\r\ \n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\ \ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A quantity- or range-valued use context assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\ \ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A quantity- or range-valued use context assigned to the graph definition\r\ \n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\ \ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A quantity- or range-valued use context assigned to the message definition\r\ \n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\ \ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A quantity- or range-valued use context assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A quantity- or range-valued\ \ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A quantity- or range-valued use context assigned to the structure definition\r\ \n* [StructureMap](structuremap.html): A quantity- or range-valued use context\ \ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A quantity- or range-valued use context assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\ \ to the value set" style: simple - name: path in: query description: A path that is constrained in the StructureDefinition style: simple - name: context in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\ \ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\ \ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\ \ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ A use context assigned to the value set" style: simple - name: base-path in: query description: Path that identifies the base element style: simple - name: keyword in: query description: A code for the StructureDefinition style: simple - name: context-type-quantity in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ capability statement\r\n* [CodeSystem](codesystem.html): A use context\ \ type and quantity- or range-based value assigned to the code system\r\n\ * [CompartmentDefinition](compartmentdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the compartment definition\r\ \n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\ \ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ message definition\r\n* [NamingSystem](namingsystem.html): A use context\ \ type and quantity- or range-based value assigned to the naming system\r\ \n* [OperationDefinition](operationdefinition.html): A use context type\ \ and quantity- or range-based value assigned to the operation definition\r\ \n* [SearchParameter](searchparameter.html): A use context type and quantity-\ \ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ A use context type and quantity- or range-based value assigned to the\ \ structure definition\r\n* [StructureMap](structuremap.html): A use context\ \ type and quantity- or range-based value assigned to the structure map\r\ \n* [TerminologyCapabilities](terminologycapabilities.html): A use context\ \ type and quantity- or range-based value assigned to the terminology capabilities\r\ \n* [ValueSet](valueset.html): A use context type and quantity- or range-based\ \ value assigned to the value set" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\ \ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\ \ External identifier for the structure map\r\n* [ValueSet](valueset.html):\ \ External identifier for the value set" style: simple - name: valueset in: query description: A vocabulary binding reference style: simple - name: kind in: query description: primitive-type | complex-type | resource | logical style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: abstract in: query description: Whether the structure is abstract style: simple - name: version in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The business version of the value set" style: simple - name: url in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\ \ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\ \ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The uri that identifies the value set" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: ext-context in: query description: "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Computationally friendly name of the value set" style: simple - name: publisher in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\ \ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ Name of the publisher of the value set" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: derivation in: query description: specialization | constraint - How relates to base definition style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\ \ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\ \ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\ \ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\ \ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\ \ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\ \ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\ \ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\ \ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\ \ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\ \ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\ \ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\ \ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\ \ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\ \ The current status of the value set" style: simple - name: base in: query description: Definition that this type is constrained/specialized from style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/$validate: get: tags: - StructureDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "StructureDefinition", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$validate: get: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resource", "resource": { "resourceType": "StructureDefinition", "id": "1" } }, { "name": "mode", "valueCode": "example" }, { "name": "profile" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$meta-delete: post: tags: - StructureDefinition 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$meta-add: post: tags: - StructureDefinition 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/$meta: get: tags: - StructureDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$meta: get: tags: - StructureDefinition 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition 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: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/$expunge: post: tags: - StructureDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$expunge: post: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/$snapshot: get: tags: - StructureDefinition parameters: - name: url in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "definition" }, { "name": "url", "valueString": "example" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$snapshot: get: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: url in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "definition" }, { "name": "url", "valueString": "example" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/$trigger-subscription: post: tags: - Subscription requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resourceId", "valueUri": "example" }, { "name": "searchUrl", "valueString": "example" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/{id}/$trigger-subscription: post: tags: - Subscription parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "resourceId", "valueUri": "example" }, { "name": "searchUrl", "valueString": "example" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/$validate-code: get: tags: - ValueSet parameters: - name: url in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: code in: query required: false style: simple - name: system in: query required: false style: simple - name: systemVersion in: query required: false style: simple - name: display in: query required: false style: simple - name: coding in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "url", "valueUri": "example" }, { "name": "valueSetVersion", "valueString": "example" }, { "name": "code", "valueCode": "example" }, { "name": "system", "valueUri": "example" }, { "name": "systemVersion", "valueString": "example" }, { "name": "display", "valueString": "example" }, { "name": "coding", "valueCoding": { "system": "http://example.com", "code": "1234" } }, { "name": "codeableConcept", "valueCodeableConcept": { "coding": [ { "system": "http://example.com", "code": "1234" } ] } } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$validate-code: get: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: url in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: code in: query required: false style: simple - name: system in: query required: false style: simple - name: systemVersion in: query required: false style: simple - name: display in: query required: false style: simple - name: coding in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "url", "valueUri": "example" }, { "name": "valueSetVersion", "valueString": "example" }, { "name": "code", "valueCode": "example" }, { "name": "system", "valueUri": "example" }, { "name": "systemVersion", "valueString": "example" }, { "name": "display", "valueString": "example" }, { "name": "coding", "valueCoding": { "system": "http://example.com", "code": "1234" } }, { "name": "codeableConcept", "valueCodeableConcept": { "coding": [ { "system": "http://example.com", "code": "1234" } ] } } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$invalidate-expansion: post: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/$expand: get: tags: - ValueSet parameters: - name: url in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: filter in: query required: false style: simple - name: context in: query required: false style: simple - name: contextDirection in: query required: false style: simple - name: offset in: query required: false style: simple - name: count in: query required: false style: simple - name: displayLanguage in: query required: false style: simple - name: includeHierarchy in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "valueSet", "resource": { "resourceType": "ValueSet", "id": "1" } }, { "name": "url", "valueUri": "example" }, { "name": "valueSetVersion", "valueString": "example" }, { "name": "filter", "valueString": "example" }, { "name": "context", "valueString": "example" }, { "name": "contextDirection", "valueString": "example" }, { "name": "offset", "valueInteger": 0 }, { "name": "count", "valueInteger": 0 }, { "name": "displayLanguage", "valueCode": "example" }, { "name": "includeHierarchy", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$expand: get: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: url in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: filter in: query required: false style: simple - name: context in: query required: false style: simple - name: contextDirection in: query required: false style: simple - name: offset in: query required: false style: simple - name: count in: query required: false style: simple - name: displayLanguage in: query required: false style: simple - name: includeHierarchy in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "valueSet", "resource": { "resourceType": "ValueSet", "id": "1" } }, { "name": "url", "valueUri": "example" }, { "name": "valueSetVersion", "valueString": "example" }, { "name": "filter", "valueString": "example" }, { "name": "context", "valueString": "example" }, { "name": "contextDirection", "valueString": "example" }, { "name": "offset", "valueInteger": 0 }, { "name": "count", "valueInteger": 0 }, { "name": "displayLanguage", "valueCode": "example" }, { "name": "includeHierarchy", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null components: schemas: FHIR-JSON-RESOURCE: type: object description: A FHIR resource example: null FHIR-XML-RESOURCE: type: object description: A FHIR resource example: null