openapi: 3.0.1
info:
title: HAPI FHIR Server
contact: {}
version: 8.9.4-SNAPSHOT/eee190b153/2026-02-26
servers:
- url: https://hapi.fhir.org/baseAudit
description: HAPI FHIR Server
tags:
- name: System Level Operations
description: Server-level operations
- name: AuditEvent
description: "The AuditEvent FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/AuditEvent"
- name: Group
description: "The Group FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Group"
- name: OperationDefinition
description: "The OperationDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/OperationDefinition"
- name: Patient
description: "The Patient FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Patient"
- 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"
/$diff:
get:
tags:
- System Level Operations
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- System Level Operations
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"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"
/$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
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"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"
/$hapi.fhir.reindex-status:
get:
tags:
- System Level Operations
summary: "GET: /$hapi.fhir.reindex-status"
parameters:
- name: _jobId
in: query
description: Query the server for the status of a reindex operation
required: true
schema:
type: string
- name: _return
in: query
description: "If provided, specifies that a specific part of the job report\
\ should be returned"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- System Level Operations
summary: "POST: /$hapi.fhir.reindex-status"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_jobId",
"valueString": "example"
}, {
"name": "_return",
"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"
/$export-poll-status:
get:
tags:
- System Level Operations
summary: "GET: /$export-poll-status"
parameters:
- name: _jobId
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- System Level Operations
summary: "POST: /$export-poll-status"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_jobId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$export:
get:
tags:
- System Level Operations
summary: "GET: /$export"
parameters:
- name: _outputFormat
in: query
required: false
schema:
type: string
- name: _type
in: query
required: false
schema:
type: string
- name: _since
in: query
required: false
schema:
type: string
- name: _until
in: query
required: false
schema:
type: string
- name: _typeFilter
in: query
required: false
schema:
type: string
- name: _typePostFetchFilterUrl
in: query
required: false
schema:
type: string
- name: _exportId
in: query
required: false
schema:
type: string
- name: _includeHistory
in: query
required: false
schema:
type: string
- name: _mdm
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- System Level Operations
summary: "POST: /$export"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_outputFormat",
"valueString": "example"
}, {
"name": "_type",
"valueString": "example"
}, {
"name": "_since"
}, {
"name": "_until"
}, {
"name": "_typeFilter",
"valueString": "example"
}, {
"name": "_typePostFetchFilterUrl",
"valueString": "example"
}, {
"name": "_exportId",
"valueString": "example"
}, {
"name": "_includeHistory",
"valueBoolean": false
}, {
"name": "_mdm",
"valueBoolean": false
}, {
"name": "patient"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$hfql-execute:
post:
tags:
- System Level Operations
summary: "POST: /$hfql-execute"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "action",
"valueCode": "example"
}, {
"name": "query",
"valueString": "example"
}, {
"name": "statement",
"valueString": "example"
}, {
"name": "continuation",
"valueString": "example"
}, {
"name": "limit",
"valueInteger": 0
}, {
"name": "offset",
"valueInteger": 0
}, {
"name": "fetchSize",
"valueInteger": 0
}, {
"name": "introspectTableName",
"valueString": "example"
}, {
"name": "introspectColumnName",
"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"
/$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"
/$hapi.fhir.undo-replace-references:
post:
tags:
- System Level Operations
summary: Restores references from target back to source for resources that were
previously updated by a $hapi.fhir.replace-references operation.
description: This operation undoes the effects of a previous $hapi.fhir.replace-references
operation by restoring references that were replaced from the target back
to the original source.
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-reference-id",
"valueString": "example"
}, {
"name": "target-reference-id",
"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"
/$hapi.fhir.replace-references:
post:
tags:
- System Level Operations
summary: Repoints referencing resources to another resources instance
description: This operation searches for all references matching the provided
id and updates them to references to the provided target-reference-id.
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-reference-id",
"valueString": "example"
}, {
"name": "target-reference-id",
"valueString": "example"
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}:
get:
tags:
- AuditEvent
summary: "read-instance: Read AuditEvent 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:
- AuditEvent
summary: "update-instance: Update an existing AuditEvent 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": "AuditEvent"
}
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:
- AuditEvent
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:
- AuditEvent
summary: "instance-patch: Patch a resource instance of type AuditEvent 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"
/AuditEvent/{id}/_history/{version_id}:
get:
tags:
- AuditEvent
summary: "vread-instance: Read AuditEvent 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"
/AuditEvent:
get:
tags:
- AuditEvent
summary: "search-type: Search for AuditEvent instances"
description: This is a search type
parameters:
- name: date
in: query
description: Time when the event was recorded
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: entity-type
in: query
description: Type of entity involved
required: false
schema:
type: string
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: agent
in: query
description: Identifier of who
required: false
schema:
type: string
- name: entity-role
in: query
description: What role the entity played
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: source
in: query
description: The identity of source detecting the event
required: false
schema:
type: string
- name: type
in: query
description: Type/identifier of event
required: false
schema:
type: string
- name: altid
in: query
description: Alternative User identity
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: agent-name
in: query
description: Human friendly name for the agent
required: false
schema:
type: string
- name: entity-name
in: query
description: Descriptor for entity
required: false
schema:
type: string
- name: subtype
in: query
description: More specific type/id for the event
required: false
schema:
type: string
- name: patient
in: query
description: Identifier of who
required: false
schema:
type: string
- name: action
in: query
description: Type of action performed during the event
required: false
schema:
type: string
- name: outcome
in: query
description: Whether the event succeeded or failed
required: false
schema:
type: string
- name: policy
in: query
description: Policy that authorized event
required: false
schema:
type: string
- name: address
in: query
description: Identifier for the network access point of the user device
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
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: site
in: query
description: Logical source location within the enterprise
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: _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: agent-role
in: query
description: Agent role in the event
required: false
schema:
type: string
- name: entity
in: query
description: Specific instance of 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:
- AuditEvent
summary: "create-type: Create a new AuditEvent instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "AuditEvent"
}
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"
/AuditEvent/_history:
get:
tags:
- AuditEvent
summary: "type-history: Fetch the resource change history for all resources\
\ of type AuditEvent"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}/_history:
get:
tags:
- AuditEvent
summary: "instance-history: Fetch the resource change history for all resources\
\ of type AuditEvent"
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"
/AuditEvent/_search:
get:
tags:
- AuditEvent
summary: "search-type: Search for AuditEvent instances"
description: This is a search type
parameters:
- name: date
in: query
description: Time when the event was recorded
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: entity-type
in: query
description: Type of entity involved
required: false
schema:
type: string
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: agent
in: query
description: Identifier of who
required: false
schema:
type: string
- name: entity-role
in: query
description: What role the entity played
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: source
in: query
description: The identity of source detecting the event
required: false
schema:
type: string
- name: type
in: query
description: Type/identifier of event
required: false
schema:
type: string
- name: altid
in: query
description: Alternative User identity
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: agent-name
in: query
description: Human friendly name for the agent
required: false
schema:
type: string
- name: entity-name
in: query
description: Descriptor for entity
required: false
schema:
type: string
- name: subtype
in: query
description: More specific type/id for the event
required: false
schema:
type: string
- name: patient
in: query
description: Identifier of who
required: false
schema:
type: string
- name: action
in: query
description: Type of action performed during the event
required: false
schema:
type: string
- name: outcome
in: query
description: Whether the event succeeded or failed
required: false
schema:
type: string
- name: policy
in: query
description: Policy that authorized event
required: false
schema:
type: string
- name: address
in: query
description: Identifier for the network access point of the user device
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
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: site
in: query
description: Logical source location within the enterprise
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: _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: agent-role
in: query
description: Agent role in the event
required: false
schema:
type: string
- name: entity
in: query
description: Specific instance of 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"
/AuditEvent/$validate:
get:
tags:
- AuditEvent
summary: "GET: /AuditEvent/$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:
- AuditEvent
summary: "POST: /AuditEvent/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "AuditEvent",
"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"
/AuditEvent/{id}/$validate:
get:
tags:
- AuditEvent
summary: "GET: /AuditEvent/{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:
- AuditEvent
summary: "POST: /AuditEvent/{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": "AuditEvent",
"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"
/AuditEvent/$hapi.fhir.undo-merge:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "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"
/AuditEvent/{id}/$meta-delete:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/{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"
/AuditEvent/{id}/$meta-add:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/{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"
/AuditEvent/$meta:
get:
tags:
- AuditEvent
summary: "GET: /AuditEvent/$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:
- AuditEvent
summary: "POST: /AuditEvent/$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"
/AuditEvent/{id}/$meta:
get:
tags:
- AuditEvent
summary: "GET: /AuditEvent/{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:
- AuditEvent
summary: "POST: /AuditEvent/{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"
/AuditEvent/$hapi.fhir.merge:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "AuditEvent",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/$expunge:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/$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"
/AuditEvent/{id}/$expunge:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/{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"
/AuditEvent/{id}/$diff:
get:
tags:
- AuditEvent
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- AuditEvent
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"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"
/AuditEvent/{id}/$reindex-dryrun:
get:
tags:
- AuditEvent
summary: "GET: /AuditEvent/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
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:
- AuditEvent
summary: "POST: /AuditEvent/{id}/$reindex-dryrun"
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": "code",
"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"
/AuditEvent/{id}/$reindex:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/{id}/$reindex"
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",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group/$export:
get:
tags:
- Group
summary: "GET: /Group/$export"
parameters:
- name: _outputFormat
in: query
required: false
schema:
type: string
- name: _type
in: query
required: false
schema:
type: string
- name: _since
in: query
required: false
schema:
type: string
- name: _until
in: query
required: false
schema:
type: string
- name: _typeFilter
in: query
required: false
schema:
type: string
- name: _typePostFetchFilterUrl
in: query
required: false
schema:
type: string
- name: _exportId
in: query
required: false
schema:
type: string
- name: _includeHistory
in: query
required: false
schema:
type: string
- name: _mdm
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Group
summary: "POST: /Group/$export"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_outputFormat",
"valueString": "example"
}, {
"name": "_type",
"valueString": "example"
}, {
"name": "_since"
}, {
"name": "_until"
}, {
"name": "_typeFilter",
"valueString": "example"
}, {
"name": "_typePostFetchFilterUrl",
"valueString": "example"
}, {
"name": "_exportId",
"valueString": "example"
}, {
"name": "_includeHistory",
"valueBoolean": false
}, {
"name": "_mdm",
"valueBoolean": false
}, {
"name": "patient"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group/{id}/$export:
get:
tags:
- Group
summary: "GET: /Group/{id}/$export"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: _outputFormat
in: query
required: false
schema:
type: string
- name: _type
in: query
required: false
schema:
type: string
- name: _since
in: query
required: false
schema:
type: string
- name: _until
in: query
required: false
schema:
type: string
- name: _typeFilter
in: query
required: false
schema:
type: string
- name: _typePostFetchFilterUrl
in: query
required: false
schema:
type: string
- name: _exportId
in: query
required: false
schema:
type: string
- name: _includeHistory
in: query
required: false
schema:
type: string
- name: _mdm
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Group
summary: "POST: /Group/{id}/$export"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_outputFormat",
"valueString": "example"
}, {
"name": "_type",
"valueString": "example"
}, {
"name": "_since"
}, {
"name": "_until"
}, {
"name": "_typeFilter",
"valueString": "example"
}, {
"name": "_typePostFetchFilterUrl",
"valueString": "example"
}, {
"name": "_exportId",
"valueString": "example"
}, {
"name": "_includeHistory",
"valueBoolean": false
}, {
"name": "_mdm",
"valueBoolean": false
}, {
"name": "patient"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group/{id}/$diff:
get:
tags:
- Group
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Group
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group/{id}/$reindex-dryrun:
get:
tags:
- Group
summary: "GET: /Group/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Group
summary: "POST: /Group/{id}/$reindex-dryrun"
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": "code",
"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"
/Group/{id}/$reindex:
post:
tags:
- Group
summary: "POST: /Group/{id}/$reindex"
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",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"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}/$diff:
get:
tags:
- OperationDefinition
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- OperationDefinition
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"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}/$reindex-dryrun:
get:
tags:
- OperationDefinition
summary: "GET: /OperationDefinition/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
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:
- OperationDefinition
summary: "POST: /OperationDefinition/{id}/$reindex-dryrun"
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": "code",
"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"
/OperationDefinition/{id}/$reindex:
post:
tags:
- OperationDefinition
summary: "POST: /OperationDefinition/{id}/$reindex"
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",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/$export:
get:
tags:
- Patient
summary: "GET: /Patient/$export"
parameters:
- name: _outputFormat
in: query
required: false
schema:
type: string
- name: _type
in: query
required: false
schema:
type: string
- name: _since
in: query
required: false
schema:
type: string
- name: _until
in: query
required: false
schema:
type: string
- name: _typeFilter
in: query
required: false
schema:
type: string
- name: _typePostFetchFilterUrl
in: query
required: false
schema:
type: string
- name: _exportId
in: query
required: false
schema:
type: string
- name: _includeHistory
in: query
required: false
schema:
type: string
- name: _mdm
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Patient
summary: "POST: /Patient/$export"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_outputFormat",
"valueString": "example"
}, {
"name": "_type",
"valueString": "example"
}, {
"name": "_since"
}, {
"name": "_until"
}, {
"name": "_typeFilter",
"valueString": "example"
}, {
"name": "_typePostFetchFilterUrl",
"valueString": "example"
}, {
"name": "_exportId",
"valueString": "example"
}, {
"name": "_includeHistory",
"valueBoolean": false
}, {
"name": "_mdm",
"valueBoolean": false
}, {
"name": "patient"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/{id}/$export:
get:
tags:
- Patient
summary: "GET: /Patient/{id}/$export"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: _outputFormat
in: query
required: false
schema:
type: string
- name: _type
in: query
required: false
schema:
type: string
- name: _since
in: query
required: false
schema:
type: string
- name: _until
in: query
required: false
schema:
type: string
- name: _typeFilter
in: query
required: false
schema:
type: string
- name: _typePostFetchFilterUrl
in: query
required: false
schema:
type: string
- name: _exportId
in: query
required: false
schema:
type: string
- name: _includeHistory
in: query
required: false
schema:
type: string
- name: _mdm
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Patient
summary: "POST: /Patient/{id}/$export"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_outputFormat",
"valueString": "example"
}, {
"name": "_type",
"valueString": "example"
}, {
"name": "_since"
}, {
"name": "_until"
}, {
"name": "_typeFilter",
"valueString": "example"
}, {
"name": "_typePostFetchFilterUrl",
"valueString": "example"
}, {
"name": "_exportId",
"valueString": "example"
}, {
"name": "_includeHistory",
"valueBoolean": false
}, {
"name": "_mdm",
"valueBoolean": false
}, {
"name": "patient"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/{id}/$diff:
get:
tags:
- Patient
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Patient
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/{id}/$reindex-dryrun:
get:
tags:
- Patient
summary: "GET: /Patient/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Patient
summary: "POST: /Patient/{id}/$reindex-dryrun"
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": "code",
"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"
/Patient/{id}/$reindex:
post:
tags:
- Patient
summary: "POST: /Patient/{id}/$reindex"
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",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"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: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- 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: _list
in: query
description: Search the contents of the resource's data using a list
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: 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: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- 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: _list
in: query
description: Search the contents of the resource's data using a list
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: 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/$hapi.fhir.undo-merge:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "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}/$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/$hapi.fhir.merge:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "SearchParameter",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"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}/$diff:
get:
tags:
- SearchParameter
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- SearchParameter
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"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}/$reindex-dryrun:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
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}/$reindex-dryrun"
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": "code",
"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"
/SearchParameter/{id}/$reindex:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$reindex"
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",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"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}:
get:
tags:
- Subscription
summary: "read-instance: Read Subscription 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:
- Subscription
summary: "update-instance: Update an existing Subscription 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": "Subscription"
}
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:
- Subscription
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:
- Subscription
summary: "instance-patch: Patch a resource instance of type Subscription 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"
/Subscription/{id}/_history/{version_id}:
get:
tags:
- Subscription
summary: "vread-instance: Read Subscription 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"
/Subscription:
get:
tags:
- Subscription
summary: "search-type: Search for Subscription instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: criteria
in: query
description: The search rules used to determine when to send a notification
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: The type of channel for the sent notifications
required: false
schema:
type: string
- name: url
in: query
description: The uri that will receive the notifications
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: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: payload
in: query
description: The mime-type of the notification payload
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: contact
in: query
description: Contact details for the subscription
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: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The current state of the subscription
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:
- Subscription
summary: "create-type: Create a new Subscription instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Subscription"
}
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"
/Subscription/_history:
get:
tags:
- Subscription
summary: "type-history: Fetch the resource change history for all resources\
\ of type Subscription"
responses:
"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}/_history:
get:
tags:
- Subscription
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Subscription"
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"
/Subscription/_search:
get:
tags:
- Subscription
summary: "search-type: Search for Subscription instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: criteria
in: query
description: The search rules used to determine when to send a notification
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: The type of channel for the sent notifications
required: false
schema:
type: string
- name: url
in: query
description: The uri that will receive the notifications
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: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: payload
in: query
description: The mime-type of the notification payload
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: contact
in: query
description: Contact details for the subscription
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: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The current state of the subscription
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"
/Subscription/$validate:
get:
tags:
- Subscription
summary: "GET: /Subscription/$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:
- Subscription
summary: "POST: /Subscription/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Subscription",
"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"
/Subscription/{id}/$validate:
get:
tags:
- Subscription
summary: "GET: /Subscription/{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:
- Subscription
summary: "POST: /Subscription/{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": "Subscription",
"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"
/Subscription/$hapi.fhir.undo-merge:
post:
tags:
- Subscription
summary: "POST: /Subscription/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "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}/$meta-delete:
post:
tags:
- Subscription
summary: "POST: /Subscription/{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"
/Subscription/{id}/$meta-add:
post:
tags:
- Subscription
summary: "POST: /Subscription/{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"
/Subscription/$meta:
get:
tags:
- Subscription
summary: "GET: /Subscription/$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:
- Subscription
summary: "POST: /Subscription/$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"
/Subscription/{id}/$meta:
get:
tags:
- Subscription
summary: "GET: /Subscription/{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:
- Subscription
summary: "POST: /Subscription/{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"
/Subscription/$hapi.fhir.merge:
post:
tags:
- Subscription
summary: "POST: /Subscription/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "Subscription",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"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/$expunge:
post:
tags:
- Subscription
summary: "POST: /Subscription/$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"
/Subscription/{id}/$expunge:
post:
tags:
- Subscription
summary: "POST: /Subscription/{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"
/Subscription/{id}/$diff:
get:
tags:
- Subscription
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Subscription
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"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}/$reindex-dryrun:
get:
tags:
- Subscription
summary: "GET: /Subscription/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
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:
- Subscription
summary: "POST: /Subscription/{id}/$reindex-dryrun"
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": "code",
"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"
/Subscription/{id}/$reindex:
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$reindex"
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",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"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}/$diff:
get:
tags:
- ValueSet
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ValueSet
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"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}/$reindex-dryrun:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
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}/$reindex-dryrun"
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": "code",
"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"
/ValueSet/{id}/$reindex:
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{id}/$reindex"
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",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"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