openapi: 3.0.1
info:
title: HAPI FHIR Server
contact: {}
version: 7.0.2
servers:
- url: https://fhir-calmhsa-provider.ehn-prod.net/fhir
description: HAPI FHIR Server
tags:
- name: System Level Operations
description: Server-level operations
- name: CodeSystem
description: "The CodeSystem FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/CodeSystem"
- name: HealthcareService
description: "The HealthcareService FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/HealthcareService"
- name: InsurancePlan
description: "The InsurancePlan FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/InsurancePlan"
- name: Location
description: "The Location FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Location"
- name: OperationDefinition
description: "The OperationDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/OperationDefinition"
- name: Organization
description: "The Organization FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Organization"
- name: Practitioner
description: "The Practitioner FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Practitioner"
- name: PractitionerRole
description: "The PractitionerRole FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/PractitionerRole"
- name: SearchParameter
description: "The SearchParameter FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SearchParameter"
- name: Subscription
description: "The Subscription FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Subscription"
- name: ValueSet
description: "The ValueSet FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ValueSet"
paths:
/metadata:
get:
tags:
- System Level Operations
summary: "server-capabilities: Fetch the server FHIR CapabilityStatement"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "CapabilityStatement"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
/:
post:
tags:
- System Level Operations
summary: "server-transaction: Execute a FHIR Transaction (or FHIR Batch) Bundle"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/_history:
get:
tags:
- System Level Operations
summary: "server-history: Fetch the resource change history across all resource\
\ types on the server"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$reindex:
post:
tags:
- System Level Operations
summary: "POST: /$reindex"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$perform-reindexing-pass:
post:
tags:
- System Level Operations
summary: "POST: /$perform-reindexing-pass"
description: Forces a single pass of the resource reindexing processor
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$meta:
get:
tags:
- System Level Operations
summary: "GET: /$meta"
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- System Level Operations
summary: "POST: /$meta"
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: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$mark-all-resources-for-reindexing:
post:
tags:
- System Level Operations
summary: "POST: /$mark-all-resources-for-reindexing"
description: "Marks all currently existing resources of a given type, or all\
\ resources of all types, for reindexing."
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "type",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$get-resource-counts:
get:
tags:
- System Level Operations
summary: "Provides the number of resources currently stored on the server, broken\
\ down by resource type"
description: "Provides the number of resources currently stored on the server,\
\ broken down by resource type"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
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: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$expunge:
post:
tags:
- System Level Operations
summary: "POST: /$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$reindex-terminology:
post:
tags:
- System Level Operations
summary: "POST: /$reindex-terminology"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/CodeSystem/$upload-external-code-system:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/$upload-external-code-system"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/CodeSystem/$apply-codesystem-delta-remove:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/$apply-codesystem-delta-remove"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/CodeSystem/$apply-codesystem-delta-add:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/$apply-codesystem-delta-add"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/CodeSystem/{id}/$binary-access-write:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/CodeSystem/{id}/$binary-access-read:
get:
tags:
- CodeSystem
summary: "GET: /CodeSystem/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}:
get:
tags:
- HealthcareService
summary: "read-instance: Read HealthcareService instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- HealthcareService
summary: "update-instance: Update an existing HealthcareService instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "HealthcareService"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- HealthcareService
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- HealthcareService
summary: "instance-patch: Patch a resource instance of type HealthcareService\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/_history/{version_id}:
get:
tags:
- HealthcareService
summary: "vread-instance: Read HealthcareService instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService:
get:
tags:
- HealthcareService
summary: "search-type: Search for HealthcareService instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: External identifiers for this item
required: false
schema:
type: string
- name: specialty
in: query
description: The specialty of the service provided by this healthcare service
required: false
schema:
type: string
- name: service-category
in: query
description: Service Category of the Healthcare Service
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: service-type
in: query
description: The type of service provided by this healthcare service
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: The Healthcare Service is currently marked as active
required: false
schema:
type: string
- name: program
in: query
description: One of the Programs supported by this HealthcareService
required: false
schema:
type: string
- name: characteristic
in: query
description: One of the HealthcareService's characteristics
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to electronic services operated
for the healthcare service
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: coverage-area
in: query
description: Location(s) service is intended for/available to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization that provides this Healthcare Service
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: A portion of the Healthcare service name
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: The location of the Healthcare Service
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- HealthcareService
summary: "create-type: Create a new HealthcareService instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "HealthcareService"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/_history:
get:
tags:
- HealthcareService
summary: "type-history: Fetch the resource change history for all resources\
\ of type HealthcareService"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/_history:
get:
tags:
- HealthcareService
summary: "instance-history: Fetch the resource change history for all resources\
\ of type HealthcareService"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/_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
required: false
schema:
type: string
- name: specialty
in: query
description: The specialty of the service provided by this healthcare service
required: false
schema:
type: string
- name: service-category
in: query
description: Service Category of the Healthcare Service
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: service-type
in: query
description: The type of service provided by this healthcare service
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: The Healthcare Service is currently marked as active
required: false
schema:
type: string
- name: program
in: query
description: One of the Programs supported by this HealthcareService
required: false
schema:
type: string
- name: characteristic
in: query
description: One of the HealthcareService's characteristics
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to electronic services operated
for the healthcare service
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: coverage-area
in: query
description: Location(s) service is intended for/available to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization that provides this Healthcare Service
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: A portion of the Healthcare service name
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: The location of the Healthcare Service
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/$validate:
get:
tags:
- HealthcareService
summary: "GET: /HealthcareService/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$validate:
get:
tags:
- HealthcareService
summary: "GET: /HealthcareService/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$meta-delete:
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$meta-add:
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/$meta:
get:
tags:
- HealthcareService
summary: "GET: /HealthcareService/$meta"
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/$meta"
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: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$meta:
get:
tags:
- HealthcareService
summary: "GET: /HealthcareService/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/$expunge:
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$expunge:
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$binary-access-write:
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$binary-access-read:
get:
tags:
- HealthcareService
summary: "GET: /HealthcareService/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}:
get:
tags:
- InsurancePlan
summary: "read-instance: Read InsurancePlan instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- InsurancePlan
summary: "update-instance: Update an existing InsurancePlan instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "InsurancePlan"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- InsurancePlan
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- InsurancePlan
summary: "instance-patch: Patch a resource instance of type InsurancePlan by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/_history/{version_id}:
get:
tags:
- InsurancePlan
summary: "vread-instance: Read InsurancePlan instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan:
get:
tags:
- InsurancePlan
summary: "search-type: Search for InsurancePlan instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Any identifier for the organization (not the accreditation issuer's
identifier)
required: false
schema:
type: string
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: owned-by
in: query
description: An organization of which this organization forms a part
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of organization
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: administered-by
in: query
description: Product administrator
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoint
required: false
schema:
type: string
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the organization's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
- name: status
in: query
description: Is the Organization record active
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- InsurancePlan
summary: "create-type: Create a new InsurancePlan instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "InsurancePlan"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/_history:
get:
tags:
- InsurancePlan
summary: "type-history: Fetch the resource change history for all resources\
\ of type InsurancePlan"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/_history:
get:
tags:
- InsurancePlan
summary: "instance-history: Fetch the resource change history for all resources\
\ of type InsurancePlan"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/_search:
get:
tags:
- InsurancePlan
summary: "search-type: Search for InsurancePlan instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Any identifier for the organization (not the accreditation issuer's
identifier)
required: false
schema:
type: string
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: owned-by
in: query
description: An organization of which this organization forms a part
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of organization
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: administered-by
in: query
description: Product administrator
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoint
required: false
schema:
type: string
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the organization's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
- name: status
in: query
description: Is the Organization record active
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/$validate:
get:
tags:
- InsurancePlan
summary: "GET: /InsurancePlan/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$validate:
get:
tags:
- InsurancePlan
summary: "GET: /InsurancePlan/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$meta-delete:
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$meta-add:
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/$meta:
get:
tags:
- InsurancePlan
summary: "GET: /InsurancePlan/$meta"
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/$meta"
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: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$meta:
get:
tags:
- InsurancePlan
summary: "GET: /InsurancePlan/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/$expunge:
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$expunge:
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$binary-access-write:
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$binary-access-read:
get:
tags:
- InsurancePlan
summary: "GET: /InsurancePlan/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}:
get:
tags:
- Location
summary: "read-instance: Read Location instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Location
summary: "update-instance: Update an existing Location instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Location"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Location
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Location
summary: "instance-patch: Patch a resource instance of type Location by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/_history/{version_id}:
get:
tags:
- Location
summary: "vread-instance: Read Location instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location:
get:
tags:
- Location
summary: "search-type: Search for Location instances"
description: This is a search type
parameters:
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: operational-status
in: query
description: "Searches for locations (typically bed/room) that have an operational\
\ status (e.g. contaminated, housekeeping)"
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of location
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the location
required: false
schema:
type: string
- 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
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
- name: identifier
in: query
description: An identifier for the location
required: false
schema:
type: string
- name: partof
in: query
description: A location of which this location is a part
required: false
schema:
type: string
- name: address
in: query
description: A (part of the) address of the location
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: Searches for locations that are managed by the provided organization
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the location's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- name: status
in: query
description: Searches for locations with a specific kind of status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Location
summary: "create-type: Create a new Location instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Location"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/_history:
get:
tags:
- Location
summary: "type-history: Fetch the resource change history for all resources\
\ of type Location"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/_history:
get:
tags:
- Location
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Location"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/_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
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: operational-status
in: query
description: "Searches for locations (typically bed/room) that have an operational\
\ status (e.g. contaminated, housekeeping)"
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of location
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the location
required: false
schema:
type: string
- 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
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
- name: identifier
in: query
description: An identifier for the location
required: false
schema:
type: string
- name: partof
in: query
description: A location of which this location is a part
required: false
schema:
type: string
- name: address
in: query
description: A (part of the) address of the location
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: Searches for locations that are managed by the provided organization
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the location's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- name: status
in: query
description: Searches for locations with a specific kind of status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/$validate:
get:
tags:
- Location
summary: "GET: /Location/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Location
summary: "POST: /Location/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$validate:
get:
tags:
- Location
summary: "GET: /Location/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Location
summary: "POST: /Location/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$meta-delete:
post:
tags:
- Location
summary: "POST: /Location/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$meta-add:
post:
tags:
- Location
summary: "POST: /Location/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/$meta:
get:
tags:
- Location
summary: "GET: /Location/$meta"
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Location
summary: "POST: /Location/$meta"
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: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$meta:
get:
tags:
- Location
summary: "GET: /Location/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Location
summary: "POST: /Location/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/$expunge:
post:
tags:
- Location
summary: "POST: /Location/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$expunge:
post:
tags:
- Location
summary: "POST: /Location/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$binary-access-write:
post:
tags:
- Location
summary: "POST: /Location/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$binary-access-read:
get:
tags:
- Location
summary: "GET: /Location/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Location
summary: "POST: /Location/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/{id}:
get:
tags:
- OperationDefinition
summary: "read-instance: Read OperationDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/{id}/$binary-access-write:
post:
tags:
- OperationDefinition
summary: "POST: /OperationDefinition/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/{id}/$binary-access-read:
get:
tags:
- OperationDefinition
summary: "GET: /OperationDefinition/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- OperationDefinition
summary: "POST: /OperationDefinition/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}:
get:
tags:
- Organization
summary: "read-instance: Read Organization instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Organization
summary: "update-instance: Update an existing Organization instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Organization"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Organization
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Organization
summary: "instance-patch: Patch a resource instance of type Organization by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/_history/{version_id}:
get:
tags:
- Organization
summary: "vread-instance: Read Organization instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization:
get:
tags:
- Organization
summary: "search-type: Search for Organization instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Any identifier for the organization (not the accreditation issuer's
identifier)
required: false
schema:
type: string
- name: partof
in: query
description: An organization of which this organization forms a part
required: false
schema:
type: string
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Is the Organization record active
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of organization
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the organization
required: false
schema:
type: string
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the organization's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Organization
summary: "create-type: Create a new Organization instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Organization"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/_history:
get:
tags:
- Organization
summary: "type-history: Fetch the resource change history for all resources\
\ of type Organization"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/_history:
get:
tags:
- Organization
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Organization"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/_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)
required: false
schema:
type: string
- name: partof
in: query
description: An organization of which this organization forms a part
required: false
schema:
type: string
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Is the Organization record active
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of organization
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the organization
required: false
schema:
type: string
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the organization's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/$validate:
get:
tags:
- Organization
summary: "GET: /Organization/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Organization
summary: "POST: /Organization/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$validate:
get:
tags:
- Organization
summary: "GET: /Organization/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$meta-delete:
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$meta-add:
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/$meta:
get:
tags:
- Organization
summary: "GET: /Organization/$meta"
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Organization
summary: "POST: /Organization/$meta"
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: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$meta:
get:
tags:
- Organization
summary: "GET: /Organization/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/$expunge:
post:
tags:
- Organization
summary: "POST: /Organization/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$expunge:
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$binary-access-write:
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$binary-access-read:
get:
tags:
- Organization
summary: "GET: /Organization/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}:
get:
tags:
- Practitioner
summary: "read-instance: Read Practitioner instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Practitioner
summary: "update-instance: Update an existing Practitioner instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Practitioner"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Practitioner
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Practitioner
summary: "instance-patch: Patch a resource instance of type Practitioner by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/_history/{version_id}:
get:
tags:
- Practitioner
summary: "vread-instance: Read Practitioner instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner:
get:
tags:
- Practitioner
summary: "search-type: Search for Practitioner instances"
description: This is a search type
parameters:
- name: address-state
in: query
description: "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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: communication
in: query
description: One of the languages that the practitioner can communicate with
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: identifier
in: query
description: A practitioner's Identifier
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether the practitioner record is active
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Practitioner
summary: "create-type: Create a new Practitioner instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Practitioner"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/_history:
get:
tags:
- Practitioner
summary: "type-history: Fetch the resource change history for all resources\
\ of type Practitioner"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/_history:
get:
tags:
- Practitioner
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Practitioner"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/_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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: communication
in: query
description: One of the languages that the practitioner can communicate with
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: identifier
in: query
description: A practitioner's Identifier
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether the practitioner record is active
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/$validate:
get:
tags:
- Practitioner
summary: "GET: /Practitioner/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Practitioner
summary: "POST: /Practitioner/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$validate:
get:
tags:
- Practitioner
summary: "GET: /Practitioner/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$meta-delete:
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$meta-add:
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/$meta:
get:
tags:
- Practitioner
summary: "GET: /Practitioner/$meta"
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Practitioner
summary: "POST: /Practitioner/$meta"
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: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$meta:
get:
tags:
- Practitioner
summary: "GET: /Practitioner/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/$expunge:
post:
tags:
- Practitioner
summary: "POST: /Practitioner/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$expunge:
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$binary-access-write:
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$binary-access-read:
get:
tags:
- Practitioner
summary: "GET: /Practitioner/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}:
get:
tags:
- PractitionerRole
summary: "read-instance: Read PractitionerRole instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- PractitionerRole
summary: "update-instance: Update an existing PractitionerRole instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "PractitionerRole"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- PractitionerRole
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- PractitionerRole
summary: "instance-patch: Patch a resource instance of type PractitionerRole\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/_history/{version_id}:
get:
tags:
- PractitionerRole
summary: "vread-instance: Read PractitionerRole instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole:
get:
tags:
- PractitionerRole
summary: "search-type: Search for PractitionerRole instances"
description: This is a search type
parameters:
- name: date
in: query
description: The period during which the practitioner is authorized to perform
in these role(s)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: A practitioner's Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: The practitioner has this specialty at an organization
required: false
schema:
type: string
- name: role
in: query
description: The practitioner can perform this role at for the organization
required: false
schema:
type: string
- name: practitioner
in: query
description: Practitioner that is able to provide the defined services for
the organization
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether this practitioner role record is in active use
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the practitioner with this role
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: service
in: query
description: The list of healthcare services that this worker provides for
this role's Organization/Location(s)
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The identity of the organization the practitioner represents
/ acts on behalf of
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: location
in: query
description: One of the locations at which this practitioner provides care
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PractitionerRole
summary: "create-type: Create a new PractitionerRole instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "PractitionerRole"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/_history:
get:
tags:
- PractitionerRole
summary: "type-history: Fetch the resource change history for all resources\
\ of type PractitionerRole"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/_history:
get:
tags:
- PractitionerRole
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PractitionerRole"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/_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)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: A practitioner's Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: The practitioner has this specialty at an organization
required: false
schema:
type: string
- name: role
in: query
description: The practitioner can perform this role at for the organization
required: false
schema:
type: string
- name: practitioner
in: query
description: Practitioner that is able to provide the defined services for
the organization
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether this practitioner role record is in active use
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the practitioner with this role
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: service
in: query
description: The list of healthcare services that this worker provides for
this role's Organization/Location(s)
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The identity of the organization the practitioner represents
/ acts on behalf of
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: location
in: query
description: One of the locations at which this practitioner provides care
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/$validate:
get:
tags:
- PractitionerRole
summary: "GET: /PractitionerRole/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$validate:
get:
tags:
- PractitionerRole
summary: "GET: /PractitionerRole/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$meta-delete:
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$meta-add:
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/$meta:
get:
tags:
- PractitionerRole
summary: "GET: /PractitionerRole/$meta"
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/$meta"
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: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$meta:
get:
tags:
- PractitionerRole
summary: "GET: /PractitionerRole/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/$expunge:
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$expunge:
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$binary-access-write:
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$binary-access-read:
get:
tags:
- PractitionerRole
summary: "GET: /PractitionerRole/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/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: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- 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: "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
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: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- 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: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/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: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/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"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: Code used in URL
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: derived-from
in: query
description: Original definition for the search parameter
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: type
in: query
description: number | date | string | token | reference | composite | quantity
| uri | special
required: false
schema:
type: string
- 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"
required: false
schema:
anyOf:
- type: string
- type: number
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: target
in: query
description: Types of resource (if a resource reference)
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: component
in: query
description: Defines how the part works
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: base
in: query
description: The resource type(s) this search parameter applies to
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- 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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/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: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/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"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: Code used in URL
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: derived-from
in: query
description: Original definition for the search parameter
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: type
in: query
description: number | date | string | token | reference | composite | quantity
| uri | special
required: false
schema:
type: string
- 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"
required: false
schema:
anyOf:
- type: string
- type: number
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: target
in: query
description: Types of resource (if a resource reference)
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: component
in: query
description: Defines how the part works
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: _text
in: query
description: Search on the narrative of the resource
required: false
schema:
type: string
- name: _content
in: query
description: Search on the entire content of the resource
required: false
schema:
type: string
- 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"
required: false
schema:
type: string
- name: base
in: query
description: The resource type(s) this search parameter applies to
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/$validate:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$validate:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$meta-delete:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$meta-add:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/$meta:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/$meta"
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/$meta"
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: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$meta:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/$expunge:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$expunge:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$binary-access-write:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$binary-access-read:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/$trigger-subscription:
post:
tags:
- Subscription
summary: "POST: /Subscription/$trigger-subscription"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/{id}/$trigger-subscription:
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$trigger-subscription"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resourceId",
"valueUri": "example"
}, {
"name": "searchUrl",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/{id}/$binary-access-write:
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/{id}/$binary-access-read:
get:
tags:
- Subscription
summary: "GET: /Subscription/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/$validate-code:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/$validate-code"
parameters:
- name: url
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: code
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: systemVersion
in: query
required: false
schema:
type: string
- name: display
in: query
required: false
schema:
type: string
- name: coding
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ValueSet
summary: "POST: /ValueSet/$validate-code"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$validate-code:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/{id}/$validate-code"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: url
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: code
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: systemVersion
in: query
required: false
schema:
type: string
- name: display
in: query
required: false
schema:
type: string
- name: coding
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{id}/$validate-code"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$invalidate-expansion:
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{id}/$invalidate-expansion"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/$expand:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/$expand"
parameters:
- name: url
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: filter
in: query
required: false
schema:
type: string
- name: context
in: query
required: false
schema:
type: string
- name: contextDirection
in: query
required: false
schema:
type: string
- name: offset
in: query
required: false
schema:
type: string
- name: count
in: query
required: false
schema:
type: string
- name: displayLanguage
in: query
required: false
schema:
type: string
- name: includeHierarchy
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ValueSet
summary: "POST: /ValueSet/$expand"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$expand:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/{id}/$expand"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: url
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: filter
in: query
required: false
schema:
type: string
- name: context
in: query
required: false
schema:
type: string
- name: contextDirection
in: query
required: false
schema:
type: string
- name: offset
in: query
required: false
schema:
type: string
- name: count
in: query
required: false
schema:
type: string
- name: displayLanguage
in: query
required: false
schema:
type: string
- name: includeHierarchy
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{id}/$expand"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "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'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$binary-access-write:
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{id}/$binary-access-write"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$binary-access-read:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: path
in: query
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{id}/$binary-access-read"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "path",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
components:
schemas:
FHIR-JSON-RESOURCE:
type: object
description: A FHIR resource
FHIR-XML-RESOURCE:
type: object
description: A FHIR resource