"
}
}
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:
- DiagnosticReport
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:
- DiagnosticReport
summary: "instance-patch: Patch a resource instance of type DiagnosticReport\
\ 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'
/DiagnosticReport/{id}/_history/{version_id}:
get:
tags:
- DiagnosticReport
summary: "vread-instance: Read DiagnosticReport 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'
/DiagnosticReport:
get:
tags:
- DiagnosticReport
summary: "search-type: Search for DiagnosticReport instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: study
in: query
description: Studies associated with the diagnostic report
style: simple
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: subject
in: query
description: The subject of the report
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: media
in: query
description: A reference to the image source.
style: simple
- name: conclusion
in: query
description: A coded conclusion (interpretation/impression) on the report
style: simple
- name: result
in: query
description: Link to an atomic result (observation resource)
style: simple
- name: based-on
in: query
description: Reference to the service request.
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: specimen
in: query
description: The specimen details
style: simple
- name: issued
in: query
description: When the report was issued
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: performer
in: query
description: Who is responsible for the report
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [Composition](composition.html): Context\
\ of the Composition * [DeviceRequest](devicerequest.html): Encounter during\
\ which request was created * [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made * [Flag](flag.html): Alert relevant\
\ during encounter * [List](list.html): Context in which list created *\
\ [NutritionOrder](nutritionorder.html): Return nutrition orders with this\
\ encounter identifier * [Observation](observation.html): Encounter related\
\ to the observation * [Procedure](procedure.html): The Encounter during\
\ which this Procedure was created * [RiskAssessment](riskassessment.html):\
\ Where was assessment performed? * [ServiceRequest](servicerequest.html):\
\ An encounter in which this request is made * [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: Which diagnostic discipline/department created the report
style: simple
- name: results-interpreter
in: query
description: Who was the source of the report
style: simple
- name: status
in: query
description: The status of the report
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- DiagnosticReport
summary: "create-type: Create a new DiagnosticReport instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "DiagnosticReport",
"text": {
"status": "generated",
"div": "
"
}
}
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'
/DiagnosticReport/_history:
get:
tags:
- DiagnosticReport
summary: "type-history: Fetch the resource change history for all resources\
\ of type DiagnosticReport"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DiagnosticReport/{id}/_history:
get:
tags:
- DiagnosticReport
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DiagnosticReport"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DiagnosticReport/$validate:
get:
tags:
- DiagnosticReport
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DiagnosticReport/{id}/$validate:
get:
tags:
- DiagnosticReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DiagnosticReport/{id}/$meta-delete:
post:
tags:
- DiagnosticReport
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DiagnosticReport/{id}/$meta-add:
post:
tags:
- DiagnosticReport
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DiagnosticReport/$meta:
get:
tags:
- DiagnosticReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DiagnosticReport/{id}/$meta:
get:
tags:
- DiagnosticReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DiagnosticReport/$expunge:
post:
tags:
- DiagnosticReport
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DiagnosticReport/{id}/$expunge:
post:
tags:
- DiagnosticReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentManifest/{id}:
get:
tags:
- DocumentManifest
summary: "read-instance: Read DocumentManifest 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:
- DocumentManifest
summary: "update-instance: Update an existing DocumentManifest 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": "DocumentManifest"
}
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:
- DocumentManifest
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:
- DocumentManifest
summary: "instance-patch: Patch a resource instance of type DocumentManifest\
\ 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'
/DocumentManifest/{id}/_history/{version_id}:
get:
tags:
- DocumentManifest
summary: "vread-instance: Read DocumentManifest 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'
/DocumentManifest:
get:
tags:
- DocumentManifest
summary: "search-type: Search for DocumentManifest instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: item
in: query
description: Items in manifest
style: simple
- name: related-id
in: query
description: Identifiers of things that are related
style: simple
- name: author
in: query
description: Who and/or what authored the DocumentManifest
style: simple
- name: created
in: query
description: When this document manifest created
style: simple
- name: subject
in: query
description: The subject of the set of documents
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: description
in: query
description: Human-readable description (title)
style: simple
- name: source
in: query
description: The source system/application/software
style: simple
- name: type
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known) * [Composition](composition.html):\
\ Kind of composition (LOINC if possible) * [DocumentManifest](documentmanifest.html):\
\ Kind of document set * [DocumentReference](documentreference.html): Kind\
\ of document (LOINC if possible) * [Encounter](encounter.html): Specific\
\ type of encounter * [EpisodeOfCare](episodeofcare.html): Type/class -\
\ e.g. specialist referral, disease management "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: related-ref
in: query
description: Related Resource
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: recipient
in: query
description: Intended to get notified about this set of documents
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: current | superseded | entered-in-error
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- DocumentManifest
summary: "create-type: Create a new DocumentManifest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "DocumentManifest"
}
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'
/DocumentManifest/_history:
get:
tags:
- DocumentManifest
summary: "type-history: Fetch the resource change history for all resources\
\ of type DocumentManifest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentManifest/{id}/_history:
get:
tags:
- DocumentManifest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DocumentManifest"
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'
/DocumentManifest/$validate:
get:
tags:
- DocumentManifest
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentManifest/{id}/$validate:
get:
tags:
- DocumentManifest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentManifest/{id}/$meta-delete:
post:
tags:
- DocumentManifest
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentManifest/{id}/$meta-add:
post:
tags:
- DocumentManifest
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentManifest/$meta:
get:
tags:
- DocumentManifest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentManifest/{id}/$meta:
get:
tags:
- DocumentManifest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentManifest/$expunge:
post:
tags:
- DocumentManifest
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentManifest/{id}/$expunge:
post:
tags:
- DocumentManifest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/{id}:
get:
tags:
- DocumentReference
summary: "read-instance: Read DocumentReference instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- DocumentReference
summary: "update-instance: Update an existing DocumentReference 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": "DocumentReference"
}
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:
- DocumentReference
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:
- DocumentReference
summary: "instance-patch: Patch a resource instance of type DocumentReference\
\ 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'
/DocumentReference/{id}/_history/{version_id}:
get:
tags:
- DocumentReference
summary: "vread-instance: Read DocumentReference 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'
/DocumentReference:
get:
tags:
- DocumentReference
summary: "search-type: Search for DocumentReference instances"
description: This is a search type
parameters:
- name: date
in: query
description: When this document reference was created
style: simple
- name: subject
in: query
description: Who/what is the subject of the document
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: description
in: query
description: Human-readable description
style: simple
- name: language
in: query
description: Human language of the content (BCP-47)
style: simple
- name: type
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known) * [Composition](composition.html):\
\ Kind of composition (LOINC if possible) * [DocumentManifest](documentmanifest.html):\
\ Kind of document set * [DocumentReference](documentreference.html): Kind\
\ of document (LOINC if possible) * [Encounter](encounter.html): Specific\
\ type of encounter * [EpisodeOfCare](episodeofcare.html): Type/class -\
\ e.g. specialist referral, disease management "
style: simple
- name: relation
in: query
description: replaces | transforms | signs | appends
style: simple
- name: setting
in: query
description: Additional details about where the content was created (e.g.
clinical specialty)
style: simple
- name: doc-status
in: query
description: preliminary | final | amended | entered-in-error
style: simple
- name: based-on
in: query
description: Procedure that caused this media to be created
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: format-canonical
in: query
description: Profile canonical content rules for the document
style: simple
- name: context
in: query
description: Context of the document content
style: simple
- name: relationship
in: query
description: Combination of relation and relatesTo
style: simple
- name: creation
in: query
description: Date attachment was first created
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: period
in: query
description: Time of service that is being documented
style: simple
- name: event-code
in: query
description: Main clinical acts documented
style: simple
- name: custodian
in: query
description: Organization which maintains the document
style: simple
- name: author
in: query
description: Who and/or what authored the document
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: format-code
in: query
description: Format code content rules for the document
style: simple
- name: format-uri
in: query
description: Profile URI content rules for the document
style: simple
- name: attester
in: query
description: Who attested the document
style: simple
- name: contenttype
in: query
description: "Mime type of the content, with charset etc."
style: simple
- name: event-reference
in: query
description: Main clinical acts documented
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: security-label
in: query
description: Document security-tags
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: Uri where the data can be found
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: Categorization of document
style: simple
- name: relatesto
in: query
description: Target of the relationship
style: simple
- name: facility
in: query
description: Kind of facility where patient was seen
style: simple
- name: status
in: query
description: current | superseded | entered-in-error
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- DocumentReference
summary: "create-type: Create a new DocumentReference instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "DocumentReference"
}
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'
/DocumentReference/_history:
get:
tags:
- DocumentReference
summary: "type-history: Fetch the resource change history for all resources\
\ of type DocumentReference"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/{id}/_history:
get:
tags:
- DocumentReference
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DocumentReference"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/$validate:
get:
tags:
- DocumentReference
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/{id}/$validate:
get:
tags:
- DocumentReference
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/{id}/$meta-delete:
post:
tags:
- DocumentReference
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/{id}/$meta-add:
post:
tags:
- DocumentReference
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/$meta:
get:
tags:
- DocumentReference
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/{id}/$meta:
get:
tags:
- DocumentReference
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/$expunge:
post:
tags:
- DocumentReference
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/DocumentReference/{id}/$expunge:
post:
tags:
- DocumentReference
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/{id}:
get:
tags:
- Encounter
summary: "read-instance: Read Encounter instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Encounter
summary: "update-instance: Update an existing Encounter instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Encounter"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Encounter
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Encounter
summary: "instance-patch: Patch a resource instance of type Encounter by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/{id}/_history/{version_id}:
get:
tags:
- Encounter
summary: "vread-instance: Read Encounter instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter:
get:
tags:
- Encounter
summary: "search-type: Search for Encounter instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: participant-type
in: query
description: Role of participant in encounter
style: simple
- name: subject
in: query
description: The patient or group present at the encounter
style: simple
- name: subject-status
in: query
description: The current status of the subject in relation to the Encounter
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: appointment
in: query
description: The appointment that scheduled this encounter
style: simple
- name: part-of
in: query
description: Another Encounter this encounter is part of
style: simple
- name: type
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known) * [Composition](composition.html):\
\ Kind of composition (LOINC if possible) * [DocumentManifest](documentmanifest.html):\
\ Kind of document set * [DocumentReference](documentreference.html): Kind\
\ of document (LOINC if possible) * [Encounter](encounter.html): Specific\
\ type of encounter * [EpisodeOfCare](episodeofcare.html): Type/class -\
\ e.g. specialist referral, disease management "
style: simple
- name: participant
in: query
description: Persons involved in the encounter other than the patient
style: simple
- name: reason-code
in: query
description: Reference to a concept (by class)
style: simple
- name: based-on
in: query
description: The ServiceRequest that initiated this encounter
style: simple
- name: date-start
in: query
description: The actual start date of the Encounter
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: location-period
in: query
description: Time period during which the patient was present at the location
style: simple
- name: special-arrangement
in: query
description: "Wheelchair, translator, stretcher, etc."
style: simple
- name: class
in: query
description: Classification of patient encounter
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: practitioner
in: query
description: Persons involved in the encounter other than the patient
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: episode-of-care
in: query
description: Episode(s) of care that this encounter should be recorded against
style: simple
- name: length
in: query
description: Length of encounter in days
style: simple
- name: diagnosis
in: query
description: The diagnosis or procedure relevant to the encounter
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: careteam
in: query
description: Careteam allocated to participate in the encounter
style: simple
- name: end-date
in: query
description: The actual end date of the Encounter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: reason-reference
in: query
description: Reference to a resource (by instance)
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: Location the encounter takes place
style: simple
- name: service-provider
in: query
description: The organization (facility) responsible for this encounter
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: account
in: query
description: The set of accounts that may be used for billing for this Encounter
style: simple
- name: status
in: query
description: planned | in-progress | onhold | completed | cancelled | entered-in-error
| unknown
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Encounter
summary: "create-type: Create a new Encounter instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Encounter"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/_history:
get:
tags:
- Encounter
summary: "type-history: Fetch the resource change history for all resources\
\ of type Encounter"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/{id}/_history:
get:
tags:
- Encounter
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Encounter"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/$validate:
get:
tags:
- Encounter
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/{id}/$validate:
get:
tags:
- Encounter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/{id}/$meta-delete:
post:
tags:
- Encounter
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/{id}/$meta-add:
post:
tags:
- Encounter
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/$meta:
get:
tags:
- Encounter
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/{id}/$meta:
get:
tags:
- Encounter
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/$expunge:
post:
tags:
- Encounter
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/{id}/$expunge:
post:
tags:
- Encounter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/$everything:
get:
tags:
- Encounter
parameters:
- name: _count
in: query
description: Results from this method are returned across multiple pages.
This parameter controls the size of those pages.
required: false
style: simple
- name: _offset
in: query
description: Results from this method are returned across multiple pages.
This parameter controls the offset when fetching a page.
required: false
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by
the given range
required: false
style: simple
- name: _content
in: query
description: "Filter the resources to return only resources matching the given\
\ _content filter (note that this filter is applied only to results which\
\ link to the given patient, not to the patient itself or to supporting\
\ resources linked to by the matched resources)"
required: false
style: simple
- name: _text
in: query
description: "Filter the resources to return only resources matching the given\
\ _text filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
style: simple
- name: _filter
in: query
description: "Filter the resources to return only resources matching the given\
\ _filter filter (note that this filter is applied only to results which\
\ link to the given patient, not to the patient itself or to supporting\
\ resources linked to by the matched resources)"
required: false
style: simple
- name: _type
in: query
description: "Filter the resources to return only resources matching the given\
\ _type filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
style: simple
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Encounter/{id}/$everything:
get:
tags:
- Encounter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: _count
in: query
description: Results from this method are returned across multiple pages.
This parameter controls the size of those pages.
required: false
style: simple
- name: _offset
in: query
description: Results from this method are returned across multiple pages.
This parameter controls the offset when fetching a page.
required: false
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by
the given range
required: false
style: simple
- name: _content
in: query
description: "Filter the resources to return only resources matching the given\
\ _content filter (note that this filter is applied only to results which\
\ link to the given patient, not to the patient itself or to supporting\
\ resources linked to by the matched resources)"
required: false
style: simple
- name: _text
in: query
description: "Filter the resources to return only resources matching the given\
\ _text filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
style: simple
- name: _filter
in: query
description: "Filter the resources to return only resources matching the given\
\ _filter filter (note that this filter is applied only to results which\
\ link to the given patient, not to the patient itself or to supporting\
\ resources linked to by the matched resources)"
required: false
style: simple
- name: _type
in: query
description: "Filter the resources to return only resources matching the given\
\ _type filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
style: simple
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Endpoint/{id}:
get:
tags:
- Endpoint
summary: "read-instance: Read Endpoint 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:
- Endpoint
summary: "update-instance: Update an existing Endpoint 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": "Endpoint"
}
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:
- Endpoint
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:
- Endpoint
summary: "instance-patch: Patch a resource instance of type Endpoint 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'
/Endpoint/{id}/_history/{version_id}:
get:
tags:
- Endpoint
summary: "vread-instance: Read Endpoint 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'
/Endpoint:
get:
tags:
- Endpoint
summary: "search-type: Search for Endpoint instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Identifies this endpoint across multiple systems
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: payload-type
in: query
description: The type of content that may be used at this endpoint (e.g. XDS
Discharge summaries)
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: connection-type
in: query
description: Protocol/Profile/Standard to be used with this endpoint connection
style: simple
- name: organization
in: query
description: The organization that is managing the endpoint
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: A name that this endpoint can be identified by
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The current status of the Endpoint (usually expected to be active)
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Endpoint
summary: "create-type: Create a new Endpoint instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Endpoint"
}
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'
/Endpoint/_history:
get:
tags:
- Endpoint
summary: "type-history: Fetch the resource change history for all resources\
\ of type Endpoint"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Endpoint/{id}/_history:
get:
tags:
- Endpoint
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Endpoint"
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'
/Endpoint/$validate:
get:
tags:
- Endpoint
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Endpoint/{id}/$validate:
get:
tags:
- Endpoint
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Endpoint/{id}/$meta-delete:
post:
tags:
- Endpoint
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Endpoint/{id}/$meta-add:
post:
tags:
- Endpoint
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Endpoint/$meta:
get:
tags:
- Endpoint
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Endpoint/{id}/$meta:
get:
tags:
- Endpoint
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Endpoint/$expunge:
post:
tags:
- Endpoint
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Endpoint/{id}/$expunge:
post:
tags:
- Endpoint
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentRequest/{id}:
get:
tags:
- EnrollmentRequest
summary: "read-instance: Read EnrollmentRequest 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:
- EnrollmentRequest
summary: "update-instance: Update an existing EnrollmentRequest 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": "EnrollmentRequest"
}
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:
- EnrollmentRequest
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:
- EnrollmentRequest
summary: "instance-patch: Patch a resource instance of type EnrollmentRequest\
\ 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'
/EnrollmentRequest/{id}/_history/{version_id}:
get:
tags:
- EnrollmentRequest
summary: "vread-instance: Read EnrollmentRequest 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'
/EnrollmentRequest:
get:
tags:
- EnrollmentRequest
summary: "search-type: Search for EnrollmentRequest instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the Enrollment
style: simple
- name: subject
in: query
description: The party to be enrolled
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: The party to be enrolled
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of the enrollment
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- EnrollmentRequest
summary: "create-type: Create a new EnrollmentRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "EnrollmentRequest"
}
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'
/EnrollmentRequest/_history:
get:
tags:
- EnrollmentRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type EnrollmentRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentRequest/{id}/_history:
get:
tags:
- EnrollmentRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EnrollmentRequest"
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'
/EnrollmentRequest/$validate:
get:
tags:
- EnrollmentRequest
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentRequest/{id}/$validate:
get:
tags:
- EnrollmentRequest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentRequest/{id}/$meta-delete:
post:
tags:
- EnrollmentRequest
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentRequest/{id}/$meta-add:
post:
tags:
- EnrollmentRequest
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentRequest/$meta:
get:
tags:
- EnrollmentRequest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentRequest/{id}/$meta:
get:
tags:
- EnrollmentRequest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentRequest/$expunge:
post:
tags:
- EnrollmentRequest
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentRequest/{id}/$expunge:
post:
tags:
- EnrollmentRequest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentResponse/{id}:
get:
tags:
- EnrollmentResponse
summary: "read-instance: Read EnrollmentResponse 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:
- EnrollmentResponse
summary: "update-instance: Update an existing EnrollmentResponse 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": "EnrollmentResponse"
}
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:
- EnrollmentResponse
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:
- EnrollmentResponse
summary: "instance-patch: Patch a resource instance of type EnrollmentResponse\
\ 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'
/EnrollmentResponse/{id}/_history/{version_id}:
get:
tags:
- EnrollmentResponse
summary: "vread-instance: Read EnrollmentResponse 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'
/EnrollmentResponse:
get:
tags:
- EnrollmentResponse
summary: "search-type: Search for EnrollmentResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the EnrollmentResponse
style: simple
- name: request
in: query
description: The reference to the claim
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of the enrollment response
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- EnrollmentResponse
summary: "create-type: Create a new EnrollmentResponse instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "EnrollmentResponse"
}
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'
/EnrollmentResponse/_history:
get:
tags:
- EnrollmentResponse
summary: "type-history: Fetch the resource change history for all resources\
\ of type EnrollmentResponse"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentResponse/{id}/_history:
get:
tags:
- EnrollmentResponse
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EnrollmentResponse"
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'
/EnrollmentResponse/$validate:
get:
tags:
- EnrollmentResponse
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentResponse/{id}/$validate:
get:
tags:
- EnrollmentResponse
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentResponse/{id}/$meta-delete:
post:
tags:
- EnrollmentResponse
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentResponse/{id}/$meta-add:
post:
tags:
- EnrollmentResponse
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentResponse/$meta:
get:
tags:
- EnrollmentResponse
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentResponse/{id}/$meta:
get:
tags:
- EnrollmentResponse
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentResponse/$expunge:
post:
tags:
- EnrollmentResponse
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EnrollmentResponse/{id}/$expunge:
post:
tags:
- EnrollmentResponse
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EpisodeOfCare/{id}:
get:
tags:
- EpisodeOfCare
summary: "read-instance: Read EpisodeOfCare 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:
- EpisodeOfCare
summary: "update-instance: Update an existing EpisodeOfCare 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": "EpisodeOfCare"
}
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:
- EpisodeOfCare
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:
- EpisodeOfCare
summary: "instance-patch: Patch a resource instance of type EpisodeOfCare 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'
/EpisodeOfCare/{id}/_history/{version_id}:
get:
tags:
- EpisodeOfCare
summary: "vread-instance: Read EpisodeOfCare 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'
/EpisodeOfCare:
get:
tags:
- EpisodeOfCare
summary: "search-type: Search for EpisodeOfCare instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: type
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known) * [Composition](composition.html):\
\ Kind of composition (LOINC if possible) * [DocumentManifest](documentmanifest.html):\
\ Kind of document set * [DocumentReference](documentreference.html): Kind\
\ of document (LOINC if possible) * [Encounter](encounter.html): Specific\
\ type of encounter * [EpisodeOfCare](episodeofcare.html): Type/class -\
\ e.g. specialist referral, disease management "
style: simple
- name: incoming-referral
in: query
description: Incoming Referral Request
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: condition-reference
in: query
description: Conditions/problems/diagnoses this episode of care is for (resource
reference)
style: simple
- name: condition
in: query
description: Conditions/problems/diagnoses this episode of care is for
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: organization
in: query
description: The organization that has assumed the specific responsibilities
of this EpisodeOfCare
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: care-manager
in: query
description: Care manager/care coordinator for the patient
style: simple
- name: condition-concept
in: query
description: Conditions/problems/diagnoses this episode of care is for (coded)
style: simple
- name: status
in: query
description: The current status of the Episode of Care as provided (does not
check the status history collection)
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- EpisodeOfCare
summary: "create-type: Create a new EpisodeOfCare instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "EpisodeOfCare"
}
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'
/EpisodeOfCare/_history:
get:
tags:
- EpisodeOfCare
summary: "type-history: Fetch the resource change history for all resources\
\ of type EpisodeOfCare"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EpisodeOfCare/{id}/_history:
get:
tags:
- EpisodeOfCare
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EpisodeOfCare"
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'
/EpisodeOfCare/$validate:
get:
tags:
- EpisodeOfCare
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EpisodeOfCare/{id}/$validate:
get:
tags:
- EpisodeOfCare
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EpisodeOfCare/{id}/$meta-delete:
post:
tags:
- EpisodeOfCare
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EpisodeOfCare/{id}/$meta-add:
post:
tags:
- EpisodeOfCare
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EpisodeOfCare/$meta:
get:
tags:
- EpisodeOfCare
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EpisodeOfCare/{id}/$meta:
get:
tags:
- EpisodeOfCare
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EpisodeOfCare/$expunge:
post:
tags:
- EpisodeOfCare
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EpisodeOfCare/{id}/$expunge:
post:
tags:
- EpisodeOfCare
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EventDefinition/{id}:
get:
tags:
- EventDefinition
summary: "read-instance: Read EventDefinition 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:
- EventDefinition
summary: "update-instance: Update an existing EventDefinition 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": "EventDefinition"
}
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:
- EventDefinition
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:
- EventDefinition
summary: "instance-patch: Patch a resource instance of type EventDefinition\
\ 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'
/EventDefinition/{id}/_history/{version_id}:
get:
tags:
- EventDefinition
summary: "vread-instance: Read EventDefinition 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'
/EventDefinition:
get:
tags:
- EventDefinition
summary: "search-type: Search for EventDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The event definition publication date
style: simple
- name: successor
in: query
description: What resource is being referenced
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the event definition
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: Intended jurisdiction for the event definition
style: simple
- name: derived-from
in: query
description: What resource is being referenced
style: simple
- name: description
in: query
description: The description of the event definition
style: simple
- name: context-type
in: query
description: A type of use context assigned to the event definition
style: simple
- name: predecessor
in: query
description: What resource is being referenced
style: simple
- name: composed-of
in: query
description: What resource is being referenced
style: simple
- name: title
in: query
description: The human-friendly name of the event definition
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the event
definition
style: simple
- name: depends-on
in: query
description: What resource is being referenced
style: simple
- name: effective
in: query
description: The time during which the event definition is intended to be
in use
style: simple
- name: context
in: query
description: A use context assigned to the event definition
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the event definition
style: simple
- name: identifier
in: query
description: External identifier for the event definition
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: The business version of the event definition
style: simple
- name: url
in: query
description: The uri that identifies the event definition
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: Computationally friendly name of the event definition
style: simple
- name: publisher
in: query
description: Name of the publisher of the event definition
style: simple
- name: topic
in: query
description: Topics associated with the module
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The current status of the event definition
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- EventDefinition
summary: "create-type: Create a new EventDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "EventDefinition"
}
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'
/EventDefinition/_history:
get:
tags:
- EventDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type EventDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EventDefinition/{id}/_history:
get:
tags:
- EventDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EventDefinition"
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'
/EventDefinition/$validate:
get:
tags:
- EventDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EventDefinition/{id}/$validate:
get:
tags:
- EventDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EventDefinition/{id}/$meta-delete:
post:
tags:
- EventDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EventDefinition/{id}/$meta-add:
post:
tags:
- EventDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EventDefinition/$meta:
get:
tags:
- EventDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EventDefinition/{id}/$meta:
get:
tags:
- EventDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EventDefinition/$expunge:
post:
tags:
- EventDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EventDefinition/{id}/$expunge:
post:
tags:
- EventDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Evidence/{id}:
get:
tags:
- Evidence
summary: "read-instance: Read Evidence 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:
- Evidence
summary: "update-instance: Update an existing Evidence 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": "Evidence"
}
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:
- Evidence
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:
- Evidence
summary: "instance-patch: Patch a resource instance of type Evidence 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'
/Evidence/{id}/_history/{version_id}:
get:
tags:
- Evidence
summary: "vread-instance: Read Evidence 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'
/Evidence:
get:
tags:
- Evidence
summary: "search-type: Search for Evidence instances"
description: This is a search type
parameters:
- name: date
in: query
description: The evidence publication date
style: simple
- name: identifier
in: query
description: External identifier for the evidence
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the evidence
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: description
in: query
description: The description of the evidence
style: simple
- name: context-type
in: query
description: A type of use context assigned to the evidence
style: simple
- name: title
in: query
description: The human-friendly name of the evidence
style: simple
- name: version
in: query
description: The business version of the evidence
style: simple
- name: url
in: query
description: The uri that identifies the evidence
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the evidence
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: context
in: query
description: A use context assigned to the evidence
style: simple
- name: publisher
in: query
description: Name of the publisher of the evidence
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the evidence
style: simple
- name: status
in: query
description: The current status of the evidence
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Evidence
summary: "create-type: Create a new Evidence instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Evidence"
}
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'
/Evidence/_history:
get:
tags:
- Evidence
summary: "type-history: Fetch the resource change history for all resources\
\ of type Evidence"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Evidence/{id}/_history:
get:
tags:
- Evidence
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Evidence"
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'
/Evidence/$validate:
get:
tags:
- Evidence
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Evidence/{id}/$validate:
get:
tags:
- Evidence
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Evidence/{id}/$meta-delete:
post:
tags:
- Evidence
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Evidence/{id}/$meta-add:
post:
tags:
- Evidence
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Evidence/$meta:
get:
tags:
- Evidence
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Evidence/{id}/$meta:
get:
tags:
- Evidence
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Evidence/$expunge:
post:
tags:
- Evidence
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Evidence/{id}/$expunge:
post:
tags:
- Evidence
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceReport/{id}:
get:
tags:
- EvidenceReport
summary: "read-instance: Read EvidenceReport 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:
- EvidenceReport
summary: "update-instance: Update an existing EvidenceReport 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": "EvidenceReport"
}
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:
- EvidenceReport
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:
- EvidenceReport
summary: "instance-patch: Patch a resource instance of type EvidenceReport 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'
/EvidenceReport/{id}/_history/{version_id}:
get:
tags:
- EvidenceReport
summary: "vread-instance: Read EvidenceReport 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'
/EvidenceReport:
get:
tags:
- EvidenceReport
summary: "search-type: Search for EvidenceReport instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: External identifier for the evidence report
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the evidence report
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: context-type
in: query
description: A type of use context assigned to the evidence report
style: simple
- name: url
in: query
description: The uri that identifies the evidence report
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the evidence
report
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: context
in: query
description: A use context assigned to the evidence report
style: simple
- name: publisher
in: query
description: Name of the publisher of the evidence report
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the evidence report
style: simple
- name: status
in: query
description: The current status of the evidence report
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- EvidenceReport
summary: "create-type: Create a new EvidenceReport instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "EvidenceReport"
}
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'
/EvidenceReport/_history:
get:
tags:
- EvidenceReport
summary: "type-history: Fetch the resource change history for all resources\
\ of type EvidenceReport"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceReport/{id}/_history:
get:
tags:
- EvidenceReport
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EvidenceReport"
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'
/EvidenceReport/$validate:
get:
tags:
- EvidenceReport
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceReport/{id}/$validate:
get:
tags:
- EvidenceReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceReport/{id}/$meta-delete:
post:
tags:
- EvidenceReport
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceReport/{id}/$meta-add:
post:
tags:
- EvidenceReport
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceReport/$meta:
get:
tags:
- EvidenceReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceReport/{id}/$meta:
get:
tags:
- EvidenceReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceReport/$expunge:
post:
tags:
- EvidenceReport
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceReport/{id}/$expunge:
post:
tags:
- EvidenceReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceVariable/{id}:
get:
tags:
- EvidenceVariable
summary: "read-instance: Read EvidenceVariable 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:
- EvidenceVariable
summary: "update-instance: Update an existing EvidenceVariable 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": "EvidenceVariable"
}
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:
- EvidenceVariable
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:
- EvidenceVariable
summary: "instance-patch: Patch a resource instance of type EvidenceVariable\
\ 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'
/EvidenceVariable/{id}/_history/{version_id}:
get:
tags:
- EvidenceVariable
summary: "vread-instance: Read EvidenceVariable 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'
/EvidenceVariable:
get:
tags:
- EvidenceVariable
summary: "search-type: Search for EvidenceVariable instances"
description: This is a search type
parameters:
- name: date
in: query
description: The evidence variable publication date
style: simple
- name: successor
in: query
description: What resource is being referenced
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the evidence variable
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: derived-from
in: query
description: What resource is being referenced
style: simple
- name: description
in: query
description: The description of the evidence variable
style: simple
- name: context-type
in: query
description: A type of use context assigned to the evidence variable
style: simple
- name: predecessor
in: query
description: What resource is being referenced
style: simple
- name: composed-of
in: query
description: What resource is being referenced
style: simple
- name: title
in: query
description: The human-friendly name of the evidence variable
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the evidence
variable
style: simple
- name: depends-on
in: query
description: What resource is being referenced
style: simple
- name: context
in: query
description: A use context assigned to the evidence variable
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the evidence variable
style: simple
- name: identifier
in: query
description: External identifier for the evidence variable
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: The business version of the evidence variable
style: simple
- name: url
in: query
description: The uri that identifies the evidence variable
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: Computationally friendly name of the evidence variable
style: simple
- name: publisher
in: query
description: Name of the publisher of the evidence variable
style: simple
- name: topic
in: query
description: Topics associated with the EvidenceVariable
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The current status of the evidence variable
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- EvidenceVariable
summary: "create-type: Create a new EvidenceVariable instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "EvidenceVariable"
}
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'
/EvidenceVariable/_history:
get:
tags:
- EvidenceVariable
summary: "type-history: Fetch the resource change history for all resources\
\ of type EvidenceVariable"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceVariable/{id}/_history:
get:
tags:
- EvidenceVariable
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EvidenceVariable"
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'
/EvidenceVariable/$validate:
get:
tags:
- EvidenceVariable
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceVariable/{id}/$validate:
get:
tags:
- EvidenceVariable
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceVariable/{id}/$meta-delete:
post:
tags:
- EvidenceVariable
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceVariable/{id}/$meta-add:
post:
tags:
- EvidenceVariable
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceVariable/$meta:
get:
tags:
- EvidenceVariable
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceVariable/{id}/$meta:
get:
tags:
- EvidenceVariable
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceVariable/$expunge:
post:
tags:
- EvidenceVariable
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/EvidenceVariable/{id}/$expunge:
post:
tags:
- EvidenceVariable
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExampleScenario/{id}:
get:
tags:
- ExampleScenario
summary: "read-instance: Read ExampleScenario 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:
- ExampleScenario
summary: "update-instance: Update an existing ExampleScenario 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": "ExampleScenario"
}
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:
- ExampleScenario
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:
- ExampleScenario
summary: "instance-patch: Patch a resource instance of type ExampleScenario\
\ 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'
/ExampleScenario/{id}/_history/{version_id}:
get:
tags:
- ExampleScenario
summary: "vread-instance: Read ExampleScenario 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'
/ExampleScenario:
get:
tags:
- ExampleScenario
summary: "search-type: Search for ExampleScenario instances"
description: This is a search type
parameters:
- name: date
in: query
description: The example scenario publication date
style: simple
- name: identifier
in: query
description: External identifier for the example scenario
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the example scenario
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: Intended jurisdiction for the example scenario
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: context-type
in: query
description: A type of use context assigned to the example scenario
style: simple
- name: version
in: query
description: The business version of the example scenario
style: simple
- name: url
in: query
description: The uri that identifies the example scenario
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the example
scenario
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: context
in: query
description: A use context assigned to the example scenario
style: simple
- name: name
in: query
description: Computationally friendly name of the example scenario
style: simple
- name: publisher
in: query
description: Name of the publisher of the example scenario
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the example scenario
style: simple
- name: status
in: query
description: The current status of the example scenario
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ExampleScenario
summary: "create-type: Create a new ExampleScenario instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ExampleScenario"
}
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'
/ExampleScenario/_history:
get:
tags:
- ExampleScenario
summary: "type-history: Fetch the resource change history for all resources\
\ of type ExampleScenario"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExampleScenario/{id}/_history:
get:
tags:
- ExampleScenario
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ExampleScenario"
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'
/ExampleScenario/$validate:
get:
tags:
- ExampleScenario
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExampleScenario/{id}/$validate:
get:
tags:
- ExampleScenario
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExampleScenario/{id}/$meta-delete:
post:
tags:
- ExampleScenario
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExampleScenario/{id}/$meta-add:
post:
tags:
- ExampleScenario
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExampleScenario/$meta:
get:
tags:
- ExampleScenario
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExampleScenario/{id}/$meta:
get:
tags:
- ExampleScenario
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExampleScenario/$expunge:
post:
tags:
- ExampleScenario
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExampleScenario/{id}/$expunge:
post:
tags:
- ExampleScenario
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/{id}:
get:
tags:
- ExplanationOfBenefit
summary: "read-instance: Read ExplanationOfBenefit instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- ExplanationOfBenefit
summary: "update-instance: Update an existing ExplanationOfBenefit instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ExplanationOfBenefit"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- ExplanationOfBenefit
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- ExplanationOfBenefit
summary: "instance-patch: Patch a resource instance of type ExplanationOfBenefit\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/{id}/_history/{version_id}:
get:
tags:
- ExplanationOfBenefit
summary: "vread-instance: Read ExplanationOfBenefit instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit:
get:
tags:
- ExplanationOfBenefit
summary: "search-type: Search for ExplanationOfBenefit instances"
description: This is a search type
parameters:
- name: care-team
in: query
description: Member of the CareTeam
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: payee
in: query
description: The party receiving any payment for the Claim
style: simple
- name: provider
in: query
description: The reference to the provider
style: simple
- name: patient
in: query
description: The reference to the patient
style: simple
- name: detail-udi
in: query
description: UDI associated with a line item detail product or service
style: simple
- name: claim
in: query
description: The reference to the claim
style: simple
- name: enterer
in: query
description: The party responsible for the entry of the Claim
style: simple
- name: procedure-udi
in: query
description: UDI associated with a procedure
style: simple
- name: item-udi
in: query
description: UDI associated with a line item product or service
style: simple
- name: coverage
in: query
description: The plan under which the claim was adjudicated
style: simple
- name: identifier
in: query
description: The business identifier of the Explanation of Benefit
style: simple
- name: created
in: query
description: The creation date for the EOB
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: Encounters associated with a billed line item
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: disposition
in: query
description: The contents of the disposition message
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: subdetail-udi
in: query
description: UDI associated with a line item detail subdetail product or service
style: simple
- name: facility
in: query
description: Facility responsible for the goods and services
style: simple
- name: status
in: query
description: Status of the instance
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ExplanationOfBenefit
summary: "create-type: Create a new ExplanationOfBenefit instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ExplanationOfBenefit"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/_history:
get:
tags:
- ExplanationOfBenefit
summary: "type-history: Fetch the resource change history for all resources\
\ of type ExplanationOfBenefit"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/{id}/_history:
get:
tags:
- ExplanationOfBenefit
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ExplanationOfBenefit"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/$validate:
get:
tags:
- ExplanationOfBenefit
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/{id}/$validate:
get:
tags:
- ExplanationOfBenefit
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/{id}/$meta-delete:
post:
tags:
- ExplanationOfBenefit
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/{id}/$meta-add:
post:
tags:
- ExplanationOfBenefit
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/$meta:
get:
tags:
- ExplanationOfBenefit
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/{id}/$meta:
get:
tags:
- ExplanationOfBenefit
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/$expunge:
post:
tags:
- ExplanationOfBenefit
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ExplanationOfBenefit/{id}/$expunge:
post:
tags:
- ExplanationOfBenefit
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FamilyMemberHistory/{id}:
get:
tags:
- FamilyMemberHistory
summary: "read-instance: Read FamilyMemberHistory 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:
- FamilyMemberHistory
summary: "update-instance: Update an existing FamilyMemberHistory 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": "FamilyMemberHistory"
}
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:
- FamilyMemberHistory
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:
- FamilyMemberHistory
summary: "instance-patch: Patch a resource instance of type FamilyMemberHistory\
\ 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'
/FamilyMemberHistory/{id}/_history/{version_id}:
get:
tags:
- FamilyMemberHistory
summary: "vread-instance: Read FamilyMemberHistory 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'
/FamilyMemberHistory:
get:
tags:
- FamilyMemberHistory
summary: "search-type: Search for FamilyMemberHistory instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: sex
in: query
description: A search by a sex code of a family member
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: relationship
in: query
description: A search by a relationship type
style: simple
- name: status
in: query
description: partial | completed | entered-in-error | health-unknown
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- FamilyMemberHistory
summary: "create-type: Create a new FamilyMemberHistory instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "FamilyMemberHistory"
}
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'
/FamilyMemberHistory/_history:
get:
tags:
- FamilyMemberHistory
summary: "type-history: Fetch the resource change history for all resources\
\ of type FamilyMemberHistory"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FamilyMemberHistory/{id}/_history:
get:
tags:
- FamilyMemberHistory
summary: "instance-history: Fetch the resource change history for all resources\
\ of type FamilyMemberHistory"
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'
/FamilyMemberHistory/$validate:
get:
tags:
- FamilyMemberHistory
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FamilyMemberHistory/{id}/$validate:
get:
tags:
- FamilyMemberHistory
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FamilyMemberHistory/{id}/$meta-delete:
post:
tags:
- FamilyMemberHistory
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FamilyMemberHistory/{id}/$meta-add:
post:
tags:
- FamilyMemberHistory
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FamilyMemberHistory/$meta:
get:
tags:
- FamilyMemberHistory
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FamilyMemberHistory/{id}/$meta:
get:
tags:
- FamilyMemberHistory
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FamilyMemberHistory/$expunge:
post:
tags:
- FamilyMemberHistory
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FamilyMemberHistory/{id}/$expunge:
post:
tags:
- FamilyMemberHistory
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Flag/{id}:
get:
tags:
- Flag
summary: "read-instance: Read Flag 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:
- Flag
summary: "update-instance: Update an existing Flag 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": "Flag"
}
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:
- Flag
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:
- Flag
summary: "instance-patch: Patch a resource instance of type Flag 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'
/Flag/{id}/_history/{version_id}:
get:
tags:
- Flag
summary: "vread-instance: Read Flag 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'
/Flag:
get:
tags:
- Flag
summary: "search-type: Search for Flag instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: identifier
in: query
description: Business identifier
style: simple
- name: author
in: query
description: Flag creator
style: simple
- name: subject
in: query
description: The identity of a subject to list flags for
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [Composition](composition.html): Context\
\ of the Composition * [DeviceRequest](devicerequest.html): Encounter during\
\ which request was created * [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made * [Flag](flag.html): Alert relevant\
\ during encounter * [List](list.html): Context in which list created *\
\ [NutritionOrder](nutritionorder.html): Return nutrition orders with this\
\ encounter identifier * [Observation](observation.html): Encounter related\
\ to the observation * [Procedure](procedure.html): The Encounter during\
\ which this Procedure was created * [RiskAssessment](riskassessment.html):\
\ Where was assessment performed? * [ServiceRequest](servicerequest.html):\
\ An encounter in which this request is made * [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: active | inactive | entered-in-error
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Flag
summary: "create-type: Create a new Flag instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Flag"
}
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'
/Flag/_history:
get:
tags:
- Flag
summary: "type-history: Fetch the resource change history for all resources\
\ of type Flag"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Flag/{id}/_history:
get:
tags:
- Flag
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Flag"
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'
/Flag/$validate:
get:
tags:
- Flag
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Flag/{id}/$validate:
get:
tags:
- Flag
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Flag/{id}/$meta-delete:
post:
tags:
- Flag
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Flag/{id}/$meta-add:
post:
tags:
- Flag
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Flag/$meta:
get:
tags:
- Flag
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Flag/{id}/$meta:
get:
tags:
- Flag
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Flag/$expunge:
post:
tags:
- Flag
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Flag/{id}/$expunge:
post:
tags:
- Flag
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FormularyItem/{id}:
get:
tags:
- FormularyItem
summary: "read-instance: Read FormularyItem 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:
- FormularyItem
summary: "update-instance: Update an existing FormularyItem 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": "FormularyItem"
}
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:
- FormularyItem
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:
- FormularyItem
summary: "instance-patch: Patch a resource instance of type FormularyItem 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'
/FormularyItem/{id}/_history/{version_id}:
get:
tags:
- FormularyItem
summary: "vread-instance: Read FormularyItem 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'
/FormularyItem:
get:
tags:
- FormularyItem
summary: "search-type: Search for FormularyItem instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Returns formulary items with this external identifier
style: simple
- name: code
in: query
description: Returns formulary items for a specific code
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- FormularyItem
summary: "create-type: Create a new FormularyItem instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "FormularyItem"
}
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'
/FormularyItem/_history:
get:
tags:
- FormularyItem
summary: "type-history: Fetch the resource change history for all resources\
\ of type FormularyItem"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FormularyItem/{id}/_history:
get:
tags:
- FormularyItem
summary: "instance-history: Fetch the resource change history for all resources\
\ of type FormularyItem"
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'
/FormularyItem/$validate:
get:
tags:
- FormularyItem
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FormularyItem/{id}/$validate:
get:
tags:
- FormularyItem
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FormularyItem/{id}/$meta-delete:
post:
tags:
- FormularyItem
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FormularyItem/{id}/$meta-add:
post:
tags:
- FormularyItem
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FormularyItem/$meta:
get:
tags:
- FormularyItem
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FormularyItem/{id}/$meta:
get:
tags:
- FormularyItem
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FormularyItem/$expunge:
post:
tags:
- FormularyItem
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/FormularyItem/{id}/$expunge:
post:
tags:
- FormularyItem
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GenomicStudy/{id}:
get:
tags:
- GenomicStudy
summary: "read-instance: Read GenomicStudy 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:
- GenomicStudy
summary: "update-instance: Update an existing GenomicStudy 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": "GenomicStudy"
}
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:
- GenomicStudy
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:
- GenomicStudy
summary: "instance-patch: Patch a resource instance of type GenomicStudy 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'
/GenomicStudy/{id}/_history/{version_id}:
get:
tags:
- GenomicStudy
summary: "vread-instance: Read GenomicStudy 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'
/GenomicStudy:
get:
tags:
- GenomicStudy
summary: "search-type: Search for GenomicStudy instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Identifiers for the Study
style: simple
- name: analysis-patient
in: query
description: Who the analysis is about
style: simple
- name: subject
in: query
description: Who the study is about
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: Who the study is about
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: analysis-subject
in: query
description: Who the analysis is about
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of the study
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- GenomicStudy
summary: "create-type: Create a new GenomicStudy instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "GenomicStudy"
}
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'
/GenomicStudy/_history:
get:
tags:
- GenomicStudy
summary: "type-history: Fetch the resource change history for all resources\
\ of type GenomicStudy"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GenomicStudy/{id}/_history:
get:
tags:
- GenomicStudy
summary: "instance-history: Fetch the resource change history for all resources\
\ of type GenomicStudy"
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'
/GenomicStudy/$validate:
get:
tags:
- GenomicStudy
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GenomicStudy/{id}/$validate:
get:
tags:
- GenomicStudy
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GenomicStudy/{id}/$meta-delete:
post:
tags:
- GenomicStudy
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GenomicStudy/{id}/$meta-add:
post:
tags:
- GenomicStudy
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GenomicStudy/$meta:
get:
tags:
- GenomicStudy
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GenomicStudy/{id}/$meta:
get:
tags:
- GenomicStudy
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GenomicStudy/$expunge:
post:
tags:
- GenomicStudy
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GenomicStudy/{id}/$expunge:
post:
tags:
- GenomicStudy
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/{id}:
get:
tags:
- Goal
summary: "read-instance: Read Goal instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Goal
summary: "update-instance: Update an existing Goal 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": "Goal"
}
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:
- Goal
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:
- Goal
summary: "instance-patch: Patch a resource instance of type Goal 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'
/Goal/{id}/_history/{version_id}:
get:
tags:
- Goal
summary: "vread-instance: Read Goal 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'
/Goal:
get:
tags:
- Goal
summary: "search-type: Search for Goal instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: addresses
in: query
description: Issues addressed by this goal
style: simple
- name: subject
in: query
description: Who this goal is intended for
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: start-date
in: query
description: When goal pursuit begins
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: lifecycle-status
in: query
description: proposed | planned | accepted | active | on-hold | completed
| cancelled | entered-in-error | rejected
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: achievement-status
in: query
description: in-progress | improving | worsening | no-change | achieved |
sustaining | not-achieved | no-progress | not-attainable
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: "E.g. Treatment, dietary, behavioral, etc."
style: simple
- name: target-date
in: query
description: Reach goal on or before
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Goal
summary: "create-type: Create a new Goal instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Goal"
}
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'
/Goal/_history:
get:
tags:
- Goal
summary: "type-history: Fetch the resource change history for all resources\
\ of type Goal"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/{id}/_history:
get:
tags:
- Goal
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Goal"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/$validate:
get:
tags:
- Goal
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/{id}/$validate:
get:
tags:
- Goal
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/{id}/$meta-delete:
post:
tags:
- Goal
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/{id}/$meta-add:
post:
tags:
- Goal
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/$meta:
get:
tags:
- Goal
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/{id}/$meta:
get:
tags:
- Goal
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/$expunge:
post:
tags:
- Goal
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Goal/{id}/$expunge:
post:
tags:
- Goal
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GraphDefinition/{id}:
get:
tags:
- GraphDefinition
summary: "read-instance: Read GraphDefinition 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:
- GraphDefinition
summary: "update-instance: Update an existing GraphDefinition 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": "GraphDefinition"
}
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:
- GraphDefinition
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:
- GraphDefinition
summary: "instance-patch: Patch a resource instance of type GraphDefinition\
\ 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'
/GraphDefinition/{id}/_history/{version_id}:
get:
tags:
- GraphDefinition
summary: "vread-instance: Read GraphDefinition 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'
/GraphDefinition:
get:
tags:
- GraphDefinition
summary: "search-type: Search for GraphDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: start
in: query
description: Type of resource at which the graph starts
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- GraphDefinition
summary: "create-type: Create a new GraphDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "GraphDefinition"
}
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'
/GraphDefinition/_history:
get:
tags:
- GraphDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type GraphDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GraphDefinition/{id}/_history:
get:
tags:
- GraphDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type GraphDefinition"
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'
/GraphDefinition/$validate:
get:
tags:
- GraphDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GraphDefinition/{id}/$validate:
get:
tags:
- GraphDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GraphDefinition/{id}/$meta-delete:
post:
tags:
- GraphDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GraphDefinition/{id}/$meta-add:
post:
tags:
- GraphDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GraphDefinition/$meta:
get:
tags:
- GraphDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GraphDefinition/{id}/$meta:
get:
tags:
- GraphDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GraphDefinition/$expunge:
post:
tags:
- GraphDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GraphDefinition/{id}/$expunge:
post:
tags:
- GraphDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Group/{id}:
get:
tags:
- Group
summary: "read-instance: Read Group instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Group
summary: "update-instance: Update an existing Group 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": "Group"
}
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:
- Group
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:
- Group
summary: "instance-patch: Patch a resource instance of type Group 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'
/Group/{id}/_history/{version_id}:
get:
tags:
- Group
summary: "vread-instance: Read Group 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'
/Group:
get:
tags:
- Group
summary: "search-type: Search for Group instances"
description: This is a search type
parameters:
- name: actual
in: query
description: Descriptive or actual
style: simple
- name: identifier
in: query
description: Unique id
style: simple
- name: managing-entity
in: query
description: Entity that is the custodian of the Group's definition
style: simple
- name: code
in: query
description: The kind of resources contained
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: membership
in: query
description: Definitional or enumerated group
style: simple
- name: type
in: query
description: The type of resources the group contains
style: simple
- name: characteristic
in: query
description: Kind of characteristic
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: characteristic-value
in: query
description: A composite of both characteristic and value
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: member
in: query
description: Reference to the group member
style: simple
- name: name
in: query
description: A portion of the Group's name
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: exclude
in: query
description: Group includes or excludes
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: value
in: query
description: Value held by characteristic
style: simple
- name: characteristic-reference
in: query
description: An entity referenced in a characteristic
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Group
summary: "create-type: Create a new Group instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Group"
}
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'
/Group/_history:
get:
tags:
- Group
summary: "type-history: Fetch the resource change history for all resources\
\ of type Group"
responses:
"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}/_history:
get:
tags:
- Group
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Group"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Group/$validate:
get:
tags:
- Group
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Group/{id}/$validate:
get:
tags:
- Group
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Group/{id}/$meta-delete:
post:
tags:
- Group
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Group/{id}/$meta-add:
post:
tags:
- Group
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Group/$meta:
get:
tags:
- Group
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Group/{id}/$meta:
get:
tags:
- Group
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Group/$expunge:
post:
tags:
- Group
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Group/{id}/$expunge:
post:
tags:
- Group
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GuidanceResponse/{id}:
get:
tags:
- GuidanceResponse
summary: "read-instance: Read GuidanceResponse 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:
- GuidanceResponse
summary: "update-instance: Update an existing GuidanceResponse 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": "GuidanceResponse"
}
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:
- GuidanceResponse
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:
- GuidanceResponse
summary: "instance-patch: Patch a resource instance of type GuidanceResponse\
\ 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'
/GuidanceResponse/{id}/_history/{version_id}:
get:
tags:
- GuidanceResponse
summary: "vread-instance: Read GuidanceResponse 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'
/GuidanceResponse:
get:
tags:
- GuidanceResponse
summary: "search-type: Search for GuidanceResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The identifier of the guidance response
style: simple
- name: request
in: query
description: The identifier of the request associated with the response
style: simple
- name: subject
in: query
description: The subject that the guidance response is about
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: The identity of a patient to search for guidance response results
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of the guidance response
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- GuidanceResponse
summary: "create-type: Create a new GuidanceResponse instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "GuidanceResponse"
}
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'
/GuidanceResponse/_history:
get:
tags:
- GuidanceResponse
summary: "type-history: Fetch the resource change history for all resources\
\ of type GuidanceResponse"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GuidanceResponse/{id}/_history:
get:
tags:
- GuidanceResponse
summary: "instance-history: Fetch the resource change history for all resources\
\ of type GuidanceResponse"
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'
/GuidanceResponse/$validate:
get:
tags:
- GuidanceResponse
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GuidanceResponse/{id}/$validate:
get:
tags:
- GuidanceResponse
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GuidanceResponse/{id}/$meta-delete:
post:
tags:
- GuidanceResponse
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GuidanceResponse/{id}/$meta-add:
post:
tags:
- GuidanceResponse
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GuidanceResponse/$meta:
get:
tags:
- GuidanceResponse
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GuidanceResponse/{id}/$meta:
get:
tags:
- GuidanceResponse
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GuidanceResponse/$expunge:
post:
tags:
- GuidanceResponse
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/GuidanceResponse/{id}/$expunge:
post:
tags:
- GuidanceResponse
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}:
get:
tags:
- HealthcareService
summary: "read-instance: Read HealthcareService instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- HealthcareService
summary: "update-instance: Update an existing HealthcareService instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "HealthcareService"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- HealthcareService
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- HealthcareService
summary: "instance-patch: Patch a resource instance of type HealthcareService\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/_history/{version_id}:
get:
tags:
- HealthcareService
summary: "vread-instance: Read HealthcareService instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService:
get:
tags:
- HealthcareService
summary: "search-type: Search for HealthcareService instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: External identifiers for this item
style: simple
- name: specialty
in: query
description: The specialty of the service provided by this healthcare service
style: simple
- name: service-category
in: query
description: Service Category of the Healthcare Service
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: service-type
in: query
description: The type of service provided by this healthcare service
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: The Healthcare Service is currently marked as active
style: simple
- name: program
in: query
description: One of the Programs supported by this HealthcareService
style: simple
- name: characteristic
in: query
description: One of the HealthcareService's characteristics
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: endpoint
in: query
description: Technical endpoints providing access to electronic services operated
for the healthcare service
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: coverage-area
in: query
description: Location(s) service is intended for/available to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: organization
in: query
description: The organization that provides this Healthcare Service
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: A portion of the Healthcare service name
style: simple
- name: offered-in
in: query
description: The service within which this service is offered
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: The location of the Healthcare Service
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- HealthcareService
summary: "create-type: Create a new HealthcareService instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "HealthcareService"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/_history:
get:
tags:
- HealthcareService
summary: "type-history: Fetch the resource change history for all resources\
\ of type HealthcareService"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/_history:
get:
tags:
- HealthcareService
summary: "instance-history: Fetch the resource change history for all resources\
\ of type HealthcareService"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/$validate:
get:
tags:
- HealthcareService
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$validate:
get:
tags:
- HealthcareService
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$meta-delete:
post:
tags:
- HealthcareService
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$meta-add:
post:
tags:
- HealthcareService
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/$meta:
get:
tags:
- HealthcareService
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$meta:
get:
tags:
- HealthcareService
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/$expunge:
post:
tags:
- HealthcareService
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/HealthcareService/{id}/$expunge:
post:
tags:
- HealthcareService
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingSelection/{id}:
get:
tags:
- ImagingSelection
summary: "read-instance: Read ImagingSelection 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:
- ImagingSelection
summary: "update-instance: Update an existing ImagingSelection 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": "ImagingSelection"
}
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:
- ImagingSelection
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:
- ImagingSelection
summary: "instance-patch: Patch a resource instance of type ImagingSelection\
\ 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'
/ImagingSelection/{id}/_history/{version_id}:
get:
tags:
- ImagingSelection
summary: "vread-instance: Read ImagingSelection 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'
/ImagingSelection:
get:
tags:
- ImagingSelection
summary: "search-type: Search for ImagingSelection instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Identifiers for the imaging selection
style: simple
- name: code
in: query
description: The imaging selection description text or code
style: simple
- name: subject
in: query
description: "The subject of the Imaging Selection, such as the associated\
\ Patient"
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: derived-from
in: query
description: The imaging study from which the imaging selection was derived
style: simple
- name: study-uid
in: query
description: The DICOM Study Instance UID from which the images were selected
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: based-on
in: query
description: The request associated with an imaging selection
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: Who the study is about
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: body-site
in: query
description: The body site associated with the imaging selection
style: simple
- name: issued
in: query
description: The date / time the imaging selection was created
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ImagingSelection
summary: "create-type: Create a new ImagingSelection instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ImagingSelection"
}
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'
/ImagingSelection/_history:
get:
tags:
- ImagingSelection
summary: "type-history: Fetch the resource change history for all resources\
\ of type ImagingSelection"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingSelection/{id}/_history:
get:
tags:
- ImagingSelection
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ImagingSelection"
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'
/ImagingSelection/$validate:
get:
tags:
- ImagingSelection
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingSelection/{id}/$validate:
get:
tags:
- ImagingSelection
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingSelection/{id}/$meta-delete:
post:
tags:
- ImagingSelection
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingSelection/{id}/$meta-add:
post:
tags:
- ImagingSelection
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingSelection/$meta:
get:
tags:
- ImagingSelection
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingSelection/{id}/$meta:
get:
tags:
- ImagingSelection
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingSelection/$expunge:
post:
tags:
- ImagingSelection
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingSelection/{id}/$expunge:
post:
tags:
- ImagingSelection
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingStudy/{id}:
get:
tags:
- ImagingStudy
summary: "read-instance: Read ImagingStudy 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:
- ImagingStudy
summary: "update-instance: Update an existing ImagingStudy 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": "ImagingStudy"
}
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:
- ImagingStudy
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:
- ImagingStudy
summary: "instance-patch: Patch a resource instance of type ImagingStudy 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'
/ImagingStudy/{id}/_history/{version_id}:
get:
tags:
- ImagingStudy
summary: "vread-instance: Read ImagingStudy 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'
/ImagingStudy:
get:
tags:
- ImagingStudy
summary: "search-type: Search for ImagingStudy instances"
description: This is a search type
parameters:
- name: reason
in: query
description: The reason for the study
style: simple
- name: dicom-class
in: query
description: The type of the instance
style: simple
- name: instance
in: query
description: SOP Instance UID for an instance
style: simple
- name: modality
in: query
description: The modality of the series
style: simple
- name: subject
in: query
description: Who the study is about
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: endpoint
in: query
description: The endpoint for the study or series
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: bodysite
in: query
description: The body site studied
style: simple
- name: performer
in: query
description: The person who performed the study
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: interpreter
in: query
description: Who interpreted the images
style: simple
- name: started
in: query
description: When the study was started
style: simple
- name: encounter
in: query
description: The context of the study
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: referrer
in: query
description: The referring physician
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: series
in: query
description: DICOM Series Instance UID for a series
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: basedon
in: query
description: "The order for the image, such as Accession Number associated\
\ with a ServiceRequest"
style: simple
- name: status
in: query
description: The status of the study
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ImagingStudy
summary: "create-type: Create a new ImagingStudy instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ImagingStudy"
}
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'
/ImagingStudy/_history:
get:
tags:
- ImagingStudy
summary: "type-history: Fetch the resource change history for all resources\
\ of type ImagingStudy"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingStudy/{id}/_history:
get:
tags:
- ImagingStudy
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ImagingStudy"
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'
/ImagingStudy/$validate:
get:
tags:
- ImagingStudy
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingStudy/{id}/$validate:
get:
tags:
- ImagingStudy
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingStudy/{id}/$meta-delete:
post:
tags:
- ImagingStudy
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingStudy/{id}/$meta-add:
post:
tags:
- ImagingStudy
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingStudy/$meta:
get:
tags:
- ImagingStudy
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingStudy/{id}/$meta:
get:
tags:
- ImagingStudy
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingStudy/$expunge:
post:
tags:
- ImagingStudy
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImagingStudy/{id}/$expunge:
post:
tags:
- ImagingStudy
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/{id}:
get:
tags:
- Immunization
summary: "read-instance: Read Immunization instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Immunization
summary: "update-instance: Update an existing Immunization instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Immunization"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Immunization
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Immunization
summary: "instance-patch: Patch a resource instance of type Immunization by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/{id}/_history/{version_id}:
get:
tags:
- Immunization
summary: "vread-instance: Read Immunization instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization:
get:
tags:
- Immunization
summary: "search-type: Search for Immunization instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: lot-number
in: query
description: Vaccine Lot Number
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: status-reason
in: query
description: Reason why the vaccine was not administered
style: simple
- name: reason-code
in: query
description: Reason why the vaccine was administered
style: simple
- name: manufacturer
in: query
description: Vaccine Manufacturer
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: reaction-date
in: query
description: When reaction started
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: performer
in: query
description: "The practitioner, individual or organization who played a role\
\ in the vaccination"
style: simple
- name: reaction
in: query
description: Additional information on reaction
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: target-disease
in: query
description: The target disease the dose is being administered against
style: simple
- name: series
in: query
description: The series being followed by the provider
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: vaccine-code
in: query
description: Vaccine Product Administered
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: reason-reference
in: query
description: Reference to a resource (by instance)
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: The service delivery location or facility in which the vaccine
was / was to be administered
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: Immunization event status
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Immunization
summary: "create-type: Create a new Immunization instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Immunization"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/_history:
get:
tags:
- Immunization
summary: "type-history: Fetch the resource change history for all resources\
\ of type Immunization"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/{id}/_history:
get:
tags:
- Immunization
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Immunization"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/$validate:
get:
tags:
- Immunization
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/{id}/$validate:
get:
tags:
- Immunization
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/{id}/$meta-delete:
post:
tags:
- Immunization
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/{id}/$meta-add:
post:
tags:
- Immunization
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/$meta:
get:
tags:
- Immunization
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/{id}/$meta:
get:
tags:
- Immunization
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/$expunge:
post:
tags:
- Immunization
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Immunization/{id}/$expunge:
post:
tags:
- Immunization
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationEvaluation/{id}:
get:
tags:
- ImmunizationEvaluation
summary: "read-instance: Read ImmunizationEvaluation 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:
- ImmunizationEvaluation
summary: "update-instance: Update an existing ImmunizationEvaluation 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": "ImmunizationEvaluation"
}
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:
- ImmunizationEvaluation
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:
- ImmunizationEvaluation
summary: "instance-patch: Patch a resource instance of type ImmunizationEvaluation\
\ 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'
/ImmunizationEvaluation/{id}/_history/{version_id}:
get:
tags:
- ImmunizationEvaluation
summary: "vread-instance: Read ImmunizationEvaluation 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'
/ImmunizationEvaluation:
get:
tags:
- ImmunizationEvaluation
summary: "search-type: Search for ImmunizationEvaluation instances"
description: This is a search type
parameters:
- name: date
in: query
description: Date the evaluation was generated
style: simple
- name: identifier
in: query
description: ID of the evaluation
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: dose-status
in: query
description: The status of the dose relative to published recommendations
style: simple
- name: immunization-event
in: query
description: The vaccine administration event being evaluated
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: target-disease
in: query
description: The vaccine preventable disease being evaluated against
style: simple
- name: patient
in: query
description: The patient being evaluated
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: Immunization evaluation status
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ImmunizationEvaluation
summary: "create-type: Create a new ImmunizationEvaluation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ImmunizationEvaluation"
}
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'
/ImmunizationEvaluation/_history:
get:
tags:
- ImmunizationEvaluation
summary: "type-history: Fetch the resource change history for all resources\
\ of type ImmunizationEvaluation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationEvaluation/{id}/_history:
get:
tags:
- ImmunizationEvaluation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ImmunizationEvaluation"
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'
/ImmunizationEvaluation/$validate:
get:
tags:
- ImmunizationEvaluation
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationEvaluation/{id}/$validate:
get:
tags:
- ImmunizationEvaluation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationEvaluation/{id}/$meta-delete:
post:
tags:
- ImmunizationEvaluation
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationEvaluation/{id}/$meta-add:
post:
tags:
- ImmunizationEvaluation
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationEvaluation/$meta:
get:
tags:
- ImmunizationEvaluation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationEvaluation/{id}/$meta:
get:
tags:
- ImmunizationEvaluation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationEvaluation/$expunge:
post:
tags:
- ImmunizationEvaluation
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationEvaluation/{id}/$expunge:
post:
tags:
- ImmunizationEvaluation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationRecommendation/{id}:
get:
tags:
- ImmunizationRecommendation
summary: "read-instance: Read ImmunizationRecommendation 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:
- ImmunizationRecommendation
summary: "update-instance: Update an existing ImmunizationRecommendation 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": "ImmunizationRecommendation"
}
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:
- ImmunizationRecommendation
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:
- ImmunizationRecommendation
summary: "instance-patch: Patch a resource instance of type ImmunizationRecommendation\
\ 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'
/ImmunizationRecommendation/{id}/_history/{version_id}:
get:
tags:
- ImmunizationRecommendation
summary: "vread-instance: Read ImmunizationRecommendation 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'
/ImmunizationRecommendation:
get:
tags:
- ImmunizationRecommendation
summary: "search-type: Search for ImmunizationRecommendation instances"
description: This is a search type
parameters:
- name: date
in: query
description: Date recommendation(s) created
style: simple
- name: identifier
in: query
description: Business identifier
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: vaccine-type
in: query
description: Vaccine or vaccine group recommendation applies to
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: target-disease
in: query
description: Disease to be immunized against
style: simple
- name: patient
in: query
description: Who this profile is for
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: information
in: query
description: Patient observations supporting recommendation
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: support
in: query
description: Past immunizations supporting recommendation
style: simple
- name: status
in: query
description: Vaccine recommendation status
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ImmunizationRecommendation
summary: "create-type: Create a new ImmunizationRecommendation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ImmunizationRecommendation"
}
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'
/ImmunizationRecommendation/_history:
get:
tags:
- ImmunizationRecommendation
summary: "type-history: Fetch the resource change history for all resources\
\ of type ImmunizationRecommendation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationRecommendation/{id}/_history:
get:
tags:
- ImmunizationRecommendation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ImmunizationRecommendation"
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'
/ImmunizationRecommendation/$validate:
get:
tags:
- ImmunizationRecommendation
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationRecommendation/{id}/$validate:
get:
tags:
- ImmunizationRecommendation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationRecommendation/{id}/$meta-delete:
post:
tags:
- ImmunizationRecommendation
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationRecommendation/{id}/$meta-add:
post:
tags:
- ImmunizationRecommendation
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationRecommendation/$meta:
get:
tags:
- ImmunizationRecommendation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationRecommendation/{id}/$meta:
get:
tags:
- ImmunizationRecommendation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationRecommendation/$expunge:
post:
tags:
- ImmunizationRecommendation
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImmunizationRecommendation/{id}/$expunge:
post:
tags:
- ImmunizationRecommendation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImplementationGuide/{id}:
get:
tags:
- ImplementationGuide
summary: "read-instance: Read ImplementationGuide 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:
- ImplementationGuide
summary: "update-instance: Update an existing ImplementationGuide 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": "ImplementationGuide"
}
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:
- ImplementationGuide
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:
- ImplementationGuide
summary: "instance-patch: Patch a resource instance of type ImplementationGuide\
\ 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'
/ImplementationGuide/{id}/_history/{version_id}:
get:
tags:
- ImplementationGuide
summary: "vread-instance: Read ImplementationGuide 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'
/ImplementationGuide:
get:
tags:
- ImplementationGuide
summary: "search-type: Search for ImplementationGuide instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: experimental
in: query
description: "For testing purposes, not real usage"
style: simple
- name: global
in: query
description: Profile that all resources must conform to
style: simple
- name: title
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system * [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map * [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition * [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition * [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition * [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ The human-friendly name of the value set "
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: depends-on
in: query
description: Identity of the IG that this depends on
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: resource
in: query
description: Location of the resource
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ImplementationGuide
summary: "create-type: Create a new ImplementationGuide instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ImplementationGuide"
}
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'
/ImplementationGuide/_history:
get:
tags:
- ImplementationGuide
summary: "type-history: Fetch the resource change history for all resources\
\ of type ImplementationGuide"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImplementationGuide/{id}/_history:
get:
tags:
- ImplementationGuide
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ImplementationGuide"
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'
/ImplementationGuide/$validate:
get:
tags:
- ImplementationGuide
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImplementationGuide/{id}/$validate:
get:
tags:
- ImplementationGuide
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImplementationGuide/{id}/$meta-delete:
post:
tags:
- ImplementationGuide
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImplementationGuide/{id}/$meta-add:
post:
tags:
- ImplementationGuide
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImplementationGuide/$meta:
get:
tags:
- ImplementationGuide
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImplementationGuide/{id}/$meta:
get:
tags:
- ImplementationGuide
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImplementationGuide/$expunge:
post:
tags:
- ImplementationGuide
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ImplementationGuide/{id}/$expunge:
post:
tags:
- ImplementationGuide
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Ingredient/{id}:
get:
tags:
- Ingredient
summary: "read-instance: Read Ingredient 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:
- Ingredient
summary: "update-instance: Update an existing Ingredient 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": "Ingredient"
}
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:
- Ingredient
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:
- Ingredient
summary: "instance-patch: Patch a resource instance of type Ingredient 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'
/Ingredient/{id}/_history/{version_id}:
get:
tags:
- Ingredient
summary: "vread-instance: Read Ingredient 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'
/Ingredient:
get:
tags:
- Ingredient
summary: "search-type: Search for Ingredient instances"
description: This is a search type
parameters:
- name: role
in: query
description: "A classification of the ingredient identifying its purpose within\
\ the product, e.g. active, inactive"
style: simple
- name: strength-presentation-ratio-numerator
in: query
description: Possiblity to search for Ingredient.substance.strength.presentation.ofType(Ratio).numerator
style: simple
- name: strength-presentation-ratio-denominator
in: query
description: Possiblity to search for Ingredient.substance.strength.presentation.ofType(Ratio).denominator
style: simple
- name: strength-ratio-and-substance
in: query
description: Possiblity to search for substance and strength at the same time
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: for
in: query
description: The product which this ingredient is a constituent part of
style: simple
- name: manufacturer
in: query
description: The organization that manufactures this ingredient
style: simple
- name: substance-definition
in: query
description: Reference to a resource (by instance)
style: simple
- name: function
in: query
description: "A classification of the ingredient identifying its precise purpose(s)\
\ in the drug product. This extends the Ingredient.role to add more detail.\
\ Example: Antioxidant, Alkalizing Agent"
style: simple
- name: strength-presentation-quantity
in: query
description: Possiblity to search for Ingredient.substance.strength.presentation.ofType(Quantity)
style: simple
- name: identifier
in: query
description: An identifier or code by which the ingredient can be referenced
style: simple
- name: reference-strength-substance-display
in: query
description: "Search for Ingredients by the 'display' field in 'referenceStrength.substance.concept.coding',\
\ focusing on substances"
style: simple
- name: substance
in: query
description: Reference to a resource (by instance)
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: substance-code
in: query
description: Reference to a concept (by class)
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: reference-strength-substance
in: query
description: Possiblity to search ingredient for substance.strength.referenceStrength.substance.concept
style: simple
- name: strength-quantity-and-substance
in: query
description: Possiblity to search for substance and strength at the same time
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: strength-presentation-ratio
in: query
description: Possiblity to search for substance and strength at the same time
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of this ingredient. Enables tracking the life-cycle
of the content
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Ingredient
summary: "create-type: Create a new Ingredient instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Ingredient"
}
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'
/Ingredient/_history:
get:
tags:
- Ingredient
summary: "type-history: Fetch the resource change history for all resources\
\ of type Ingredient"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Ingredient/{id}/_history:
get:
tags:
- Ingredient
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Ingredient"
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'
/Ingredient/$validate:
get:
tags:
- Ingredient
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Ingredient/{id}/$validate:
get:
tags:
- Ingredient
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Ingredient/{id}/$meta-delete:
post:
tags:
- Ingredient
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Ingredient/{id}/$meta-add:
post:
tags:
- Ingredient
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Ingredient/$meta:
get:
tags:
- Ingredient
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Ingredient/{id}/$meta:
get:
tags:
- Ingredient
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Ingredient/$expunge:
post:
tags:
- Ingredient
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Ingredient/{id}/$expunge:
post:
tags:
- Ingredient
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}:
get:
tags:
- InsurancePlan
summary: "read-instance: Read InsurancePlan instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- InsurancePlan
summary: "update-instance: Update an existing InsurancePlan instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "InsurancePlan"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- InsurancePlan
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- InsurancePlan
summary: "instance-patch: Patch a resource instance of type InsurancePlan by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/_history/{version_id}:
get:
tags:
- InsurancePlan
summary: "vread-instance: Read InsurancePlan instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan:
get:
tags:
- InsurancePlan
summary: "search-type: Search for InsurancePlan instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Any identifier for the organization (not the accreditation issuer's
identifier)
style: simple
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
style: simple
- name: address-state
in: query
description: A state specified in an address
style: simple
- name: owned-by
in: query
description: An organization of which this organization forms a part
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: type
in: query
description: A code for the type of organization
style: simple
- name: address-postalcode
in: query
description: A postal code specified in an address
style: simple
- name: address-country
in: query
description: A country specified in an address
style: simple
- name: administered-by
in: query
description: Product administrator
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: endpoint
in: query
description: Technical endpoint
style: simple
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: address-use
in: query
description: A use code specified in an address
style: simple
- name: name
in: query
description: A portion of the organization's name or alias
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: address-city
in: query
description: A city specified in an address
style: simple
- name: status
in: query
description: Is the Organization record active
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- InsurancePlan
summary: "create-type: Create a new InsurancePlan instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "InsurancePlan"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/_history:
get:
tags:
- InsurancePlan
summary: "type-history: Fetch the resource change history for all resources\
\ of type InsurancePlan"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/_history:
get:
tags:
- InsurancePlan
summary: "instance-history: Fetch the resource change history for all resources\
\ of type InsurancePlan"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/$validate:
get:
tags:
- InsurancePlan
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$validate:
get:
tags:
- InsurancePlan
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$meta-delete:
post:
tags:
- InsurancePlan
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$meta-add:
post:
tags:
- InsurancePlan
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/$meta:
get:
tags:
- InsurancePlan
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$meta:
get:
tags:
- InsurancePlan
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/$expunge:
post:
tags:
- InsurancePlan
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InsurancePlan/{id}/$expunge:
post:
tags:
- InsurancePlan
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InventoryReport/{id}:
get:
tags:
- InventoryReport
summary: "read-instance: Read InventoryReport 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:
- InventoryReport
summary: "update-instance: Update an existing InventoryReport 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": "InventoryReport"
}
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:
- InventoryReport
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:
- InventoryReport
summary: "instance-patch: Patch a resource instance of type InventoryReport\
\ 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'
/InventoryReport/{id}/_history/{version_id}:
get:
tags:
- InventoryReport
summary: "vread-instance: Read InventoryReport 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'
/InventoryReport:
get:
tags:
- InventoryReport
summary: "search-type: Search for InventoryReport instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- InventoryReport
summary: "create-type: Create a new InventoryReport instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "InventoryReport"
}
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'
/InventoryReport/_history:
get:
tags:
- InventoryReport
summary: "type-history: Fetch the resource change history for all resources\
\ of type InventoryReport"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InventoryReport/{id}/_history:
get:
tags:
- InventoryReport
summary: "instance-history: Fetch the resource change history for all resources\
\ of type InventoryReport"
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'
/InventoryReport/$validate:
get:
tags:
- InventoryReport
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InventoryReport/{id}/$validate:
get:
tags:
- InventoryReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InventoryReport/{id}/$meta-delete:
post:
tags:
- InventoryReport
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InventoryReport/{id}/$meta-add:
post:
tags:
- InventoryReport
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InventoryReport/$meta:
get:
tags:
- InventoryReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InventoryReport/{id}/$meta:
get:
tags:
- InventoryReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InventoryReport/$expunge:
post:
tags:
- InventoryReport
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/InventoryReport/{id}/$expunge:
post:
tags:
- InventoryReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Invoice/{id}:
get:
tags:
- Invoice
summary: "read-instance: Read Invoice 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:
- Invoice
summary: "update-instance: Update an existing Invoice 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": "Invoice"
}
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:
- Invoice
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:
- Invoice
summary: "instance-patch: Patch a resource instance of type Invoice 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'
/Invoice/{id}/_history/{version_id}:
get:
tags:
- Invoice
summary: "vread-instance: Read Invoice 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'
/Invoice:
get:
tags:
- Invoice
summary: "search-type: Search for Invoice instances"
description: This is a search type
parameters:
- name: date
in: query
description: Invoice date / posting date
style: simple
- name: identifier
in: query
description: Business Identifier for item
style: simple
- name: totalgross
in: query
description: Gross total of this Invoice
style: simple
- name: participant-role
in: query
description: Type of involvement in creation of this Invoice
style: simple
- name: subject
in: query
description: Recipient(s) of goods and services
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: type
in: query
description: Type of Invoice
style: simple
- name: issuer
in: query
description: Issuing Organization of Invoice
style: simple
- name: participant
in: query
description: Individual who was involved
style: simple
- name: totalnet
in: query
description: Net total of this Invoice
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: Recipient(s) of goods and services
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: recipient
in: query
description: Recipient of this invoice
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: account
in: query
description: Account that is being balanced
style: simple
- name: status
in: query
description: draft | issued | balanced | cancelled | entered-in-error
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Invoice
summary: "create-type: Create a new Invoice instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Invoice"
}
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'
/Invoice/_history:
get:
tags:
- Invoice
summary: "type-history: Fetch the resource change history for all resources\
\ of type Invoice"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Invoice/{id}/_history:
get:
tags:
- Invoice
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Invoice"
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'
/Invoice/$validate:
get:
tags:
- Invoice
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Invoice/{id}/$validate:
get:
tags:
- Invoice
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Invoice/{id}/$meta-delete:
post:
tags:
- Invoice
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Invoice/{id}/$meta-add:
post:
tags:
- Invoice
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Invoice/$meta:
get:
tags:
- Invoice
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Invoice/{id}/$meta:
get:
tags:
- Invoice
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Invoice/$expunge:
post:
tags:
- Invoice
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Invoice/{id}/$expunge:
post:
tags:
- Invoice
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Library/{id}:
get:
tags:
- Library
summary: "read-instance: Read Library 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:
- Library
summary: "update-instance: Update an existing Library 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": "Library"
}
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:
- Library
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:
- Library
summary: "instance-patch: Patch a resource instance of type Library 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'
/Library/{id}/_history/{version_id}:
get:
tags:
- Library
summary: "vread-instance: Read Library 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'
/Library:
get:
tags:
- Library
summary: "search-type: Search for Library instances"
description: This is a search type
parameters:
- name: date
in: query
description: The library publication date
style: simple
- name: successor
in: query
description: What resource is being referenced
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the library
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: Intended jurisdiction for the library
style: simple
- name: derived-from
in: query
description: What resource is being referenced
style: simple
- name: description
in: query
description: The description of the library
style: simple
- name: context-type
in: query
description: A type of use context assigned to the library
style: simple
- name: predecessor
in: query
description: What resource is being referenced
style: simple
- name: composed-of
in: query
description: What resource is being referenced
style: simple
- name: title
in: query
description: The human-friendly name of the library
style: simple
- name: type
in: query
description: "The type of the library (e.g. logic-library, model-definition,\
\ asset-collection, module-definition)"
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the library
style: simple
- name: depends-on
in: query
description: What resource is being referenced
style: simple
- name: effective
in: query
description: The time during which the library is intended to be in use
style: simple
- name: context
in: query
description: A use context assigned to the library
style: simple
- name: content-type
in: query
description: The type of content in the library (e.g. text/cql)
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the library
style: simple
- name: identifier
in: query
description: External identifier for the library
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: The business version of the library
style: simple
- name: url
in: query
description: The uri that identifies the library
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: Computationally friendly name of the library
style: simple
- name: publisher
in: query
description: Name of the publisher of the library
style: simple
- name: topic
in: query
description: Topics associated with the module
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The current status of the library
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Library
summary: "create-type: Create a new Library instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Library"
}
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'
/Library/_history:
get:
tags:
- Library
summary: "type-history: Fetch the resource change history for all resources\
\ of type Library"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Library/{id}/_history:
get:
tags:
- Library
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Library"
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'
/Library/$validate:
get:
tags:
- Library
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Library/{id}/$validate:
get:
tags:
- Library
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Library/{id}/$meta-delete:
post:
tags:
- Library
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Library/{id}/$meta-add:
post:
tags:
- Library
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Library/$meta:
get:
tags:
- Library
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Library/{id}/$meta:
get:
tags:
- Library
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Library/$expunge:
post:
tags:
- Library
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Library/{id}/$expunge:
post:
tags:
- Library
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Linkage/{id}:
get:
tags:
- Linkage
summary: "read-instance: Read Linkage 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:
- Linkage
summary: "update-instance: Update an existing Linkage 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": "Linkage"
}
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:
- Linkage
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:
- Linkage
summary: "instance-patch: Patch a resource instance of type Linkage 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'
/Linkage/{id}/_history/{version_id}:
get:
tags:
- Linkage
summary: "vread-instance: Read Linkage 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'
/Linkage:
get:
tags:
- Linkage
summary: "search-type: Search for Linkage instances"
description: This is a search type
parameters:
- name: item
in: query
description: Matches on any item in the Linkage
style: simple
- name: author
in: query
description: Author of the Linkage
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: source
in: query
description: Matches on any item in the Linkage with a type of 'source'
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
responses:
"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:
- Linkage
summary: "create-type: Create a new Linkage instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Linkage"
}
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'
/Linkage/_history:
get:
tags:
- Linkage
summary: "type-history: Fetch the resource change history for all resources\
\ of type Linkage"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Linkage/{id}/_history:
get:
tags:
- Linkage
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Linkage"
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'
/Linkage/$validate:
get:
tags:
- Linkage
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Linkage/{id}/$validate:
get:
tags:
- Linkage
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Linkage/{id}/$meta-delete:
post:
tags:
- Linkage
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Linkage/{id}/$meta-add:
post:
tags:
- Linkage
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Linkage/$meta:
get:
tags:
- Linkage
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Linkage/{id}/$meta:
get:
tags:
- Linkage
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Linkage/$expunge:
post:
tags:
- Linkage
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Linkage/{id}/$expunge:
post:
tags:
- Linkage
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/{id}:
get:
tags:
- List
summary: "read-instance: Read List instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- List
summary: "update-instance: Update an existing List instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "List"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- List
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- List
summary: "instance-patch: Patch a resource instance of type List by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/{id}/_history/{version_id}:
get:
tags:
- List
summary: "vread-instance: Read List instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List:
get:
tags:
- List
summary: "search-type: Search for List instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: empty-reason
in: query
description: Why list is empty
style: simple
- name: item
in: query
description: Actual entry
style: simple
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: notes
in: query
description: The annotation - text content (as markdown)
style: simple
- name: subject
in: query
description: If all resources have the same subject
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [Composition](composition.html): Context\
\ of the Composition * [DeviceRequest](devicerequest.html): Encounter during\
\ which request was created * [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made * [Flag](flag.html): Alert relevant\
\ during encounter * [List](list.html): Context in which list created *\
\ [NutritionOrder](nutritionorder.html): Return nutrition orders with this\
\ encounter identifier * [Observation](observation.html): Encounter related\
\ to the observation * [Procedure](procedure.html): The Encounter during\
\ which this Procedure was created * [RiskAssessment](riskassessment.html):\
\ Where was assessment performed? * [ServiceRequest](servicerequest.html):\
\ An encounter in which this request is made * [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: source
in: query
description: Who and/or what defined the list contents (aka Author)
style: simple
- name: title
in: query
description: Descriptive name for the list
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: current | retired | entered-in-error
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- List
summary: "create-type: Create a new List instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "List"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/_history:
get:
tags:
- List
summary: "type-history: Fetch the resource change history for all resources\
\ of type List"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/{id}/_history:
get:
tags:
- List
summary: "instance-history: Fetch the resource change history for all resources\
\ of type List"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/$validate:
get:
tags:
- List
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/{id}/$validate:
get:
tags:
- List
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/{id}/$meta-delete:
post:
tags:
- List
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/{id}/$meta-add:
post:
tags:
- List
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/$meta:
get:
tags:
- List
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/{id}/$meta:
get:
tags:
- List
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/$expunge:
post:
tags:
- List
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/List/{id}/$expunge:
post:
tags:
- List
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}:
get:
tags:
- Location
summary: "read-instance: Read Location instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Location
summary: "update-instance: Update an existing Location instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Location"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Location
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Location
summary: "instance-patch: Patch a resource instance of type Location by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/_history/{version_id}:
get:
tags:
- Location
summary: "vread-instance: Read Location instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location:
get:
tags:
- Location
summary: "search-type: Search for Location instances"
description: This is a search type
parameters:
- name: address-state
in: query
description: A state specified in an address
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: operational-status
in: query
description: "Searches for locations (typically bed/room) that have an operational\
\ status (e.g. contaminated, housekeeping)"
style: simple
- name: type
in: query
description: A code for the type of location
style: simple
- name: characteristic
in: query
description: One of the Location's characteristics
style: simple
- name: address-country
in: query
description: A country specified in an address
style: simple
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the location
style: simple
- name: near
in: query
description: "Search for locations where the location.position is near to,\
\ or within a specified distance of, the provided coordinates expressed\
\ as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see\
\ notes). Servers which support the near parameter SHALL support the unit\
\ string 'km' for kilometers and SHOULD support '[mi_us]' for miles, support\
\ for other units is optional. If the units are omitted, then kms should\
\ be assumed. If the distance is omitted, then the server can use its own\
\ discretion as to what distances should be considered near (and units are\
\ irrelevant). Servers may search using various techniques that might have\
\ differing accuracies, depending on implementation efficiency. If the server\
\ is unable to understand the units (and does support the near search parameter),\
\ it MAY return an OperationOutcome and fail the search with a http status\
\ 403 BadRequest. If the server does not support the near parameter, the\
\ parameter MAY report the unused parameter in a bundled OperationOutcome\
\ and still perform the search ignoring the near parameter."
style: simple
- name: address-city
in: query
description: A city specified in an address
style: simple
- name: identifier
in: query
description: An identifier for the location
style: simple
- name: partof
in: query
description: A location of which this location is a part
style: simple
- name: address
in: query
description: A (part of the) address of the location
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: address-postalcode
in: query
description: A postal code specified in an address
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: contains
in: query
description: Select locations that contain the specified co-ordinates
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: organization
in: query
description: Searches for locations that are managed by the provided organization
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: address-use
in: query
description: A use code specified in an address
style: simple
- name: name
in: query
description: A portion of the location's name or alias
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: Searches for locations with a specific kind of status
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Location
summary: "create-type: Create a new Location instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Location"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/_history:
get:
tags:
- Location
summary: "type-history: Fetch the resource change history for all resources\
\ of type Location"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/_history:
get:
tags:
- Location
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Location"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/$validate:
get:
tags:
- Location
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$validate:
get:
tags:
- Location
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$meta-delete:
post:
tags:
- Location
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$meta-add:
post:
tags:
- Location
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/$meta:
get:
tags:
- Location
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$meta:
get:
tags:
- Location
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/$expunge:
post:
tags:
- Location
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Location/{id}/$expunge:
post:
tags:
- Location
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ManufacturedItemDefinition/{id}:
get:
tags:
- ManufacturedItemDefinition
summary: "read-instance: Read ManufacturedItemDefinition 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:
- ManufacturedItemDefinition
summary: "update-instance: Update an existing ManufacturedItemDefinition 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": "ManufacturedItemDefinition"
}
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:
- ManufacturedItemDefinition
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:
- ManufacturedItemDefinition
summary: "instance-patch: Patch a resource instance of type ManufacturedItemDefinition\
\ 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'
/ManufacturedItemDefinition/{id}/_history/{version_id}:
get:
tags:
- ManufacturedItemDefinition
summary: "vread-instance: Read ManufacturedItemDefinition 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'
/ManufacturedItemDefinition:
get:
tags:
- ManufacturedItemDefinition
summary: "search-type: Search for ManufacturedItemDefinition instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Unique identifier
style: simple
- name: ingredient
in: query
description: An ingredient of this item
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: A descriptive name applied to this item
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: dose-form
in: query
description: Dose form as manufactured and before any transformation into
the pharmaceutical product
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of this item. Enables tracking the life-cycle of the
content.
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ManufacturedItemDefinition
summary: "create-type: Create a new ManufacturedItemDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ManufacturedItemDefinition"
}
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'
/ManufacturedItemDefinition/_history:
get:
tags:
- ManufacturedItemDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type ManufacturedItemDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ManufacturedItemDefinition/{id}/_history:
get:
tags:
- ManufacturedItemDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ManufacturedItemDefinition"
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'
/ManufacturedItemDefinition/$validate:
get:
tags:
- ManufacturedItemDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ManufacturedItemDefinition/{id}/$validate:
get:
tags:
- ManufacturedItemDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ManufacturedItemDefinition/{id}/$meta-delete:
post:
tags:
- ManufacturedItemDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ManufacturedItemDefinition/{id}/$meta-add:
post:
tags:
- ManufacturedItemDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ManufacturedItemDefinition/$meta:
get:
tags:
- ManufacturedItemDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ManufacturedItemDefinition/{id}/$meta:
get:
tags:
- ManufacturedItemDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ManufacturedItemDefinition/$expunge:
post:
tags:
- ManufacturedItemDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ManufacturedItemDefinition/{id}/$expunge:
post:
tags:
- ManufacturedItemDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Measure/{id}:
get:
tags:
- Measure
summary: "read-instance: Read Measure 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:
- Measure
summary: "update-instance: Update an existing Measure 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": "Measure"
}
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:
- Measure
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:
- Measure
summary: "instance-patch: Patch a resource instance of type Measure 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'
/Measure/{id}/_history/{version_id}:
get:
tags:
- Measure
summary: "vread-instance: Read Measure 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'
/Measure:
get:
tags:
- Measure
summary: "search-type: Search for Measure instances"
description: This is a search type
parameters:
- name: date
in: query
description: The measure publication date
style: simple
- name: successor
in: query
description: What resource is being referenced
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the measure
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: Intended jurisdiction for the measure
style: simple
- name: derived-from
in: query
description: What resource is being referenced
style: simple
- name: description
in: query
description: The description of the measure
style: simple
- name: context-type
in: query
description: A type of use context assigned to the measure
style: simple
- name: predecessor
in: query
description: What resource is being referenced
style: simple
- name: composed-of
in: query
description: What resource is being referenced
style: simple
- name: title
in: query
description: The human-friendly name of the measure
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the measure
style: simple
- name: depends-on
in: query
description: What resource is being referenced
style: simple
- name: effective
in: query
description: The time during which the measure is intended to be in use
style: simple
- name: context
in: query
description: A use context assigned to the measure
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the measure
style: simple
- name: identifier
in: query
description: External identifier for the measure
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: The business version of the measure
style: simple
- name: url
in: query
description: The uri that identifies the measure
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: Computationally friendly name of the measure
style: simple
- name: publisher
in: query
description: Name of the publisher of the measure
style: simple
- name: topic
in: query
description: Topics associated with the measure
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The current status of the measure
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Measure
summary: "create-type: Create a new Measure instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Measure"
}
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'
/Measure/_history:
get:
tags:
- Measure
summary: "type-history: Fetch the resource change history for all resources\
\ of type Measure"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Measure/{id}/_history:
get:
tags:
- Measure
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Measure"
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'
/Measure/$validate:
get:
tags:
- Measure
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Measure/{id}/$validate:
get:
tags:
- Measure
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Measure/{id}/$meta-delete:
post:
tags:
- Measure
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Measure/{id}/$meta-add:
post:
tags:
- Measure
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Measure/$meta:
get:
tags:
- Measure
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Measure/{id}/$meta:
get:
tags:
- Measure
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Measure/$expunge:
post:
tags:
- Measure
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Measure/{id}/$expunge:
post:
tags:
- Measure
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MeasureReport/{id}:
get:
tags:
- MeasureReport
summary: "read-instance: Read MeasureReport 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:
- MeasureReport
summary: "update-instance: Update an existing MeasureReport 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": "MeasureReport"
}
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:
- MeasureReport
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:
- MeasureReport
summary: "instance-patch: Patch a resource instance of type MeasureReport 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'
/MeasureReport/{id}/_history/{version_id}:
get:
tags:
- MeasureReport
summary: "vread-instance: Read MeasureReport 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'
/MeasureReport:
get:
tags:
- MeasureReport
summary: "search-type: Search for MeasureReport instances"
description: This is a search type
parameters:
- name: date
in: query
description: The date of the measure report
style: simple
- name: identifier
in: query
description: External identifier of the measure report to be returned
style: simple
- name: period
in: query
description: The period of the measure report
style: simple
- name: subject
in: query
description: The identity of a subject to search for individual measure report
results for
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: reporter
in: query
description: The reporter to return measure report results for
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: measure
in: query
description: The measure to return measure report results for
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: The identity of a patient to search for individual measure report
results for
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: The location to return measure report results for
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: evaluated-resource
in: query
description: An evaluated resource referenced by the measure report
style: simple
- name: status
in: query
description: The status of the measure report
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- MeasureReport
summary: "create-type: Create a new MeasureReport instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MeasureReport"
}
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'
/MeasureReport/_history:
get:
tags:
- MeasureReport
summary: "type-history: Fetch the resource change history for all resources\
\ of type MeasureReport"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MeasureReport/{id}/_history:
get:
tags:
- MeasureReport
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MeasureReport"
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'
/MeasureReport/$validate:
get:
tags:
- MeasureReport
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MeasureReport/{id}/$validate:
get:
tags:
- MeasureReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MeasureReport/{id}/$meta-delete:
post:
tags:
- MeasureReport
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MeasureReport/{id}/$meta-add:
post:
tags:
- MeasureReport
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MeasureReport/$meta:
get:
tags:
- MeasureReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MeasureReport/{id}/$meta:
get:
tags:
- MeasureReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MeasureReport/$expunge:
post:
tags:
- MeasureReport
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MeasureReport/{id}/$expunge:
post:
tags:
- MeasureReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/{id}:
get:
tags:
- Medication
summary: "read-instance: Read Medication instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Medication
summary: "update-instance: Update an existing Medication instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Medication",
"text": {
"status": "generated",
"div": "
"
}
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Medication
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Medication
summary: "instance-patch: Patch a resource instance of type Medication by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/{id}/_history/{version_id}:
get:
tags:
- Medication
summary: "vread-instance: Read Medication instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication:
get:
tags:
- Medication
summary: "search-type: Search for Medication instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Returns medications with this external identifier
style: simple
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: ingredient
in: query
description: Returns medications for this ingredient reference
style: simple
- name: lot-number
in: query
description: Returns medications in a batch with this lot number
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: marketingauthorizationholder
in: query
description: Returns medications made or sold for this marketing authorization
holder
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: ingredient-code
in: query
description: Returns medications for this ingredient code
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: form
in: query
description: Returns medications for a specific dose form
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: expiration-date
in: query
description: Returns medications in a batch with this expiration date
style: simple
- name: status
in: query
description: Returns medications for this status
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Medication
summary: "create-type: Create a new Medication instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Medication",
"text": {
"status": "generated",
"div": "
"
}
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/_history:
get:
tags:
- Medication
summary: "type-history: Fetch the resource change history for all resources\
\ of type Medication"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/{id}/_history:
get:
tags:
- Medication
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Medication"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/$validate:
get:
tags:
- Medication
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/{id}/$validate:
get:
tags:
- Medication
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/{id}/$meta-delete:
post:
tags:
- Medication
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/{id}/$meta-add:
post:
tags:
- Medication
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/$meta:
get:
tags:
- Medication
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/{id}/$meta:
get:
tags:
- Medication
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/$expunge:
post:
tags:
- Medication
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Medication/{id}/$expunge:
post:
tags:
- Medication
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationAdministration/{id}:
get:
tags:
- MedicationAdministration
summary: "read-instance: Read MedicationAdministration 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:
- MedicationAdministration
summary: "update-instance: Update an existing MedicationAdministration 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": "MedicationAdministration"
}
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:
- MedicationAdministration
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:
- MedicationAdministration
summary: "instance-patch: Patch a resource instance of type MedicationAdministration\
\ 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'
/MedicationAdministration/{id}/_history/{version_id}:
get:
tags:
- MedicationAdministration
summary: "vread-instance: Read MedicationAdministration 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'
/MedicationAdministration:
get:
tags:
- MedicationAdministration
summary: "search-type: Search for MedicationAdministration instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ Date administration happened (or did not happen) "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: request
in: query
description: The identity of a request to list administrations from
style: simple
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: performer
in: query
description: The identity of the individual who administered the medication
style: simple
- name: subject
in: query
description: The identity of the individual or group to list administrations
for
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: medication
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication reference * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication reference "
style: simple
- name: reason-given
in: query
description: Reference to a resource (by instance)
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ Return administrations that share this encounter * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: reason-given-code
in: query
description: Reasons for administering the medication
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: reason-not-given
in: query
description: Reasons for not administering the medication
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: device
in: query
description: Return administrations with this administration device identity
style: simple
- name: status
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\
\ * [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status * [MedicationRequest](medicationrequest.html):\
\ Status of the prescription * [MedicationUsage](medicationusage.html):\
\ Return statements that match the given status "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- MedicationAdministration
summary: "create-type: Create a new MedicationAdministration instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MedicationAdministration"
}
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'
/MedicationAdministration/_history:
get:
tags:
- MedicationAdministration
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationAdministration"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationAdministration/{id}/_history:
get:
tags:
- MedicationAdministration
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationAdministration"
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'
/MedicationAdministration/$validate:
get:
tags:
- MedicationAdministration
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationAdministration/{id}/$validate:
get:
tags:
- MedicationAdministration
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationAdministration/{id}/$meta-delete:
post:
tags:
- MedicationAdministration
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationAdministration/{id}/$meta-add:
post:
tags:
- MedicationAdministration
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationAdministration/$meta:
get:
tags:
- MedicationAdministration
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationAdministration/{id}/$meta:
get:
tags:
- MedicationAdministration
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationAdministration/$expunge:
post:
tags:
- MedicationAdministration
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationAdministration/{id}/$expunge:
post:
tags:
- MedicationAdministration
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/{id}:
get:
tags:
- MedicationDispense
summary: "read-instance: Read MedicationDispense instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- MedicationDispense
summary: "update-instance: Update an existing MedicationDispense instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MedicationDispense"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- MedicationDispense
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- MedicationDispense
summary: "instance-patch: Patch a resource instance of type MedicationDispense\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/{id}/_history/{version_id}:
get:
tags:
- MedicationDispense
summary: "vread-instance: Read MedicationDispense instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense:
get:
tags:
- MedicationDispense
summary: "search-type: Search for MedicationDispense instances"
description: This is a search type
parameters:
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: subject
in: query
description: The identity of a patient for whom to list dispenses
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: destination
in: query
description: Returns dispenses that should be sent to a specific destination
style: simple
- name: type
in: query
description: Returns dispenses of a specific type
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: performer
in: query
description: Returns dispenses performed by a specific individual
style: simple
- name: receiver
in: query
description: The identity of a receiver to list dispenses for
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: medication
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication reference * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication reference "
style: simple
- name: responsibleparty
in: query
description: Returns dispenses with the specified responsible party
style: simple
- name: encounter
in: query
description: Returns dispenses with a specific encounter
style: simple
- name: recorded
in: query
description: Returns dispenses where dispensing activity began on this date
style: simple
- name: whenhandedover
in: query
description: Returns dispenses handed over on this date
style: simple
- name: whenprepared
in: query
description: Returns dispenses prepared on this date
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: prescription
in: query
description: "Multiple Resources: * [MedicationDispense](medicationdispense.html):\
\ The identity of a prescription to list dispenses from "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: Returns dispense for a given location
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\
\ * [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status * [MedicationRequest](medicationrequest.html):\
\ Status of the prescription * [MedicationUsage](medicationusage.html):\
\ Return statements that match the given status "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- MedicationDispense
summary: "create-type: Create a new MedicationDispense instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MedicationDispense"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/_history:
get:
tags:
- MedicationDispense
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationDispense"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/{id}/_history:
get:
tags:
- MedicationDispense
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationDispense"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/$validate:
get:
tags:
- MedicationDispense
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/{id}/$validate:
get:
tags:
- MedicationDispense
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/{id}/$meta-delete:
post:
tags:
- MedicationDispense
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/{id}/$meta-add:
post:
tags:
- MedicationDispense
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/$meta:
get:
tags:
- MedicationDispense
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/{id}/$meta:
get:
tags:
- MedicationDispense
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/$expunge:
post:
tags:
- MedicationDispense
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationDispense/{id}/$expunge:
post:
tags:
- MedicationDispense
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/{id}:
get:
tags:
- MedicationKnowledge
summary: "read-instance: Read MedicationKnowledge instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- MedicationKnowledge
summary: "update-instance: Update an existing MedicationKnowledge instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MedicationKnowledge"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- MedicationKnowledge
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- MedicationKnowledge
summary: "instance-patch: Patch a resource instance of type MedicationKnowledge\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/{id}/_history/{version_id}:
get:
tags:
- MedicationKnowledge
summary: "vread-instance: Read MedicationKnowledge instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge:
get:
tags:
- MedicationKnowledge
summary: "search-type: Search for MedicationKnowledge instances"
description: This is a search type
parameters:
- name: code
in: query
description: Code that identifies this medication
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: classification-type
in: query
description: "The type of category for the medication (for example, therapeutic\
\ classification, therapeutic sub-classification)"
style: simple
- name: monograph-type
in: query
description: The category of medication document
style: simple
- name: ingredient-code
in: query
description: Reference to a concept (by class)
style: simple
- name: packaging-cost-concept
in: query
description: "The cost of the packaged medication, if the cost is a CodeableConcept"
style: simple
- name: source-cost
in: query
description: The source or owner for the price information
style: simple
- name: monitoring-program-name
in: query
description: Name of the reviewing program
style: simple
- name: monitoring-program-type
in: query
description: Type of program under which the medication is monitored
style: simple
- name: packaging-cost
in: query
description: "The cost of the packaged medication, if the cost is Money"
style: simple
- name: product-type
in: query
description: Category of the medication or product
style: simple
- name: identifier
in: query
description: Business identifier for this medication
style: simple
- name: ingredient
in: query
description: Reference to a resource (by instance)
style: simple
- name: doseform
in: query
description: powder | tablets | capsule +
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: classification
in: query
description: Specific category assigned to the medication
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: monograph
in: query
description: Associated documentation about the medication
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: active | inactive | entered-in-error
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- MedicationKnowledge
summary: "create-type: Create a new MedicationKnowledge instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MedicationKnowledge"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/_history:
get:
tags:
- MedicationKnowledge
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationKnowledge"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/{id}/_history:
get:
tags:
- MedicationKnowledge
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationKnowledge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/$validate:
get:
tags:
- MedicationKnowledge
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/{id}/$validate:
get:
tags:
- MedicationKnowledge
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/{id}/$meta-delete:
post:
tags:
- MedicationKnowledge
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/{id}/$meta-add:
post:
tags:
- MedicationKnowledge
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/$meta:
get:
tags:
- MedicationKnowledge
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/{id}/$meta:
get:
tags:
- MedicationKnowledge
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/$expunge:
post:
tags:
- MedicationKnowledge
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationKnowledge/{id}/$expunge:
post:
tags:
- MedicationKnowledge
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/{id}:
get:
tags:
- MedicationRequest
summary: "read-instance: Read MedicationRequest instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- MedicationRequest
summary: "update-instance: Update an existing MedicationRequest instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MedicationRequest"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- MedicationRequest
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- MedicationRequest
summary: "instance-patch: Patch a resource instance of type MedicationRequest\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/{id}/_history/{version_id}:
get:
tags:
- MedicationRequest
summary: "vread-instance: Read MedicationRequest instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest:
get:
tags:
- MedicationRequest
summary: "search-type: Search for MedicationRequest instances"
description: This is a search type
parameters:
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: authoredon
in: query
description: Return prescriptions written on this date
style: simple
- name: subject
in: query
description: The identity of a patient to list orders for
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: intended-performer
in: query
description: Returns the intended performer of the administration of the medication
request
style: simple
- name: intended-performertype
in: query
description: Returns requests for a specific type of performer
style: simple
- name: requester
in: query
description: Returns prescriptions prescribed by this prescriber
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: intended-dispenser
in: query
description: Returns prescriptions intended to be dispensed by this Organization
style: simple
- name: combo-date
in: query
description: Returns medication request to be administered on a specific date
or within a date range
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: medication
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication reference * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication reference "
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ Return administrations that share this encounter * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: priority
in: query
description: Returns prescriptions with different priorities
style: simple
- name: intent
in: query
description: Returns prescriptions with different intents
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: Returns prescriptions with different categories
style: simple
- name: status
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\
\ * [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status * [MedicationRequest](medicationrequest.html):\
\ Status of the prescription * [MedicationUsage](medicationusage.html):\
\ Return statements that match the given status "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- MedicationRequest
summary: "create-type: Create a new MedicationRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MedicationRequest"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/_history:
get:
tags:
- MedicationRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/{id}/_history:
get:
tags:
- MedicationRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationRequest"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/$validate:
get:
tags:
- MedicationRequest
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/{id}/$validate:
get:
tags:
- MedicationRequest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/{id}/$meta-delete:
post:
tags:
- MedicationRequest
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/{id}/$meta-add:
post:
tags:
- MedicationRequest
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/$meta:
get:
tags:
- MedicationRequest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/{id}/$meta:
get:
tags:
- MedicationRequest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/$expunge:
post:
tags:
- MedicationRequest
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationRequest/{id}/$expunge:
post:
tags:
- MedicationRequest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationUsage/{id}:
get:
tags:
- MedicationUsage
summary: "read-instance: Read MedicationUsage 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:
- MedicationUsage
summary: "update-instance: Update an existing MedicationUsage 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": "MedicationUsage"
}
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:
- MedicationUsage
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:
- MedicationUsage
summary: "instance-patch: Patch a resource instance of type MedicationUsage\
\ 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'
/MedicationUsage/{id}/_history/{version_id}:
get:
tags:
- MedicationUsage
summary: "vread-instance: Read MedicationUsage 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'
/MedicationUsage:
get:
tags:
- MedicationUsage
summary: "search-type: Search for MedicationUsage instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: adherence
in: query
description: Returns statements based on adherence or compliance
style: simple
- name: subject
in: query
description: "The identity of a patient, animal or group to list statements\
\ for"
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: medication
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication reference * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication reference "
style: simple
- name: encounter
in: query
description: Returns statements for a specific encounter
style: simple
- name: source
in: query
description: Who or where the information in the statement came from
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: effective
in: query
description: Date when patient was taking (or not taking) the medication
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: Returns statements of this category of MedicationUsage
style: simple
- name: status
in: query
description: "Multiple Resources: * [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\
\ * [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status * [MedicationRequest](medicationrequest.html):\
\ Status of the prescription * [MedicationUsage](medicationusage.html):\
\ Return statements that match the given status "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- MedicationUsage
summary: "create-type: Create a new MedicationUsage instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MedicationUsage"
}
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'
/MedicationUsage/_history:
get:
tags:
- MedicationUsage
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationUsage"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationUsage/{id}/_history:
get:
tags:
- MedicationUsage
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationUsage"
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'
/MedicationUsage/$validate:
get:
tags:
- MedicationUsage
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationUsage/{id}/$validate:
get:
tags:
- MedicationUsage
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationUsage/{id}/$meta-delete:
post:
tags:
- MedicationUsage
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationUsage/{id}/$meta-add:
post:
tags:
- MedicationUsage
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationUsage/$meta:
get:
tags:
- MedicationUsage
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationUsage/{id}/$meta:
get:
tags:
- MedicationUsage
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationUsage/$expunge:
post:
tags:
- MedicationUsage
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicationUsage/{id}/$expunge:
post:
tags:
- MedicationUsage
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicinalProductDefinition/{id}:
get:
tags:
- MedicinalProductDefinition
summary: "read-instance: Read MedicinalProductDefinition 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:
- MedicinalProductDefinition
summary: "update-instance: Update an existing MedicinalProductDefinition 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": "MedicinalProductDefinition"
}
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:
- MedicinalProductDefinition
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:
- MedicinalProductDefinition
summary: "instance-patch: Patch a resource instance of type MedicinalProductDefinition\
\ 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'
/MedicinalProductDefinition/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductDefinition
summary: "vread-instance: Read MedicinalProductDefinition 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'
/MedicinalProductDefinition:
get:
tags:
- MedicinalProductDefinition
summary: "search-type: Search for MedicinalProductDefinition instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Business identifier for this product. Could be an MPID
style: simple
- name: country
in: query
description: Search for MedicinalProductDefinition by country
style: simple
- name: ingredient
in: query
description: An ingredient of this product
style: simple
- name: master-file
in: query
description: A master file for to the medicinal product (e.g. Pharmacovigilance
System Master File)
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: name-language
in: query
description: Language code for this name
style: simple
- name: type
in: query
description: "Regulatory type, e.g. Investigational or Authorized"
style: simple
- name: name-language-correct
in: query
description: Possiblity to search ingredient for MedicinalProductDefinition.name.usage.language
style: simple
- name: characteristic
in: query
description: "Allows the key product features to be recorded, such as \"sugar\
\ free\", \"modified release\", \"parallel import\""
style: simple
- name: characteristic-type
in: query
description: A category for the characteristic
style: simple
- name: product-classification
in: query
description: Allows the product to be classified by various systems
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: contact
in: query
description: "A product specific contact, person (in a role), or an organization"
style: simple
- name: domain
in: query
description: If this medicine applies to human or veterinary uses
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: The full product name
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "The status within the lifecycle of this product record. A high-level\
\ status, this is not intended to duplicate details carried elsewhere such\
\ as legal status, or authorization status"
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- MedicinalProductDefinition
summary: "create-type: Create a new MedicinalProductDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MedicinalProductDefinition"
}
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'
/MedicinalProductDefinition/_history:
get:
tags:
- MedicinalProductDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicinalProductDefinition/{id}/_history:
get:
tags:
- MedicinalProductDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductDefinition"
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'
/MedicinalProductDefinition/$validate:
get:
tags:
- MedicinalProductDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicinalProductDefinition/{id}/$validate:
get:
tags:
- MedicinalProductDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicinalProductDefinition/{id}/$meta-delete:
post:
tags:
- MedicinalProductDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicinalProductDefinition/{id}/$meta-add:
post:
tags:
- MedicinalProductDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicinalProductDefinition/$meta:
get:
tags:
- MedicinalProductDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicinalProductDefinition/{id}/$meta:
get:
tags:
- MedicinalProductDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicinalProductDefinition/$expunge:
post:
tags:
- MedicinalProductDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MedicinalProductDefinition/{id}/$expunge:
post:
tags:
- MedicinalProductDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageDefinition/{id}:
get:
tags:
- MessageDefinition
summary: "read-instance: Read MessageDefinition 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:
- MessageDefinition
summary: "update-instance: Update an existing MessageDefinition 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": "MessageDefinition"
}
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:
- MessageDefinition
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:
- MessageDefinition
summary: "instance-patch: Patch a resource instance of type MessageDefinition\
\ 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'
/MessageDefinition/{id}/_history/{version_id}:
get:
tags:
- MessageDefinition
summary: "vread-instance: Read MessageDefinition 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'
/MessageDefinition:
get:
tags:
- MessageDefinition
summary: "search-type: Search for MessageDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: parent
in: query
description: A resource that is the parent of the definition
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: focus
in: query
description: A resource that is a permitted focus of the message
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: title
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system * [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map * [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition * [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition * [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition * [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ The human-friendly name of the value set "
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: event
in: query
description: The event that triggers the message or link to the event definition.
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [CodeSystem](codesystem.html): External\
\ identifier for the code system * [ConceptMap](conceptmap.html): External\
\ identifier for the concept map * [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition * [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition * [StructureMap](structuremap.html):\
\ External identifier for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ External identifier for the terminology capabilities * [ValueSet](valueset.html):\
\ External identifier for the value set "
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: The behavior associated with the message
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- MessageDefinition
summary: "create-type: Create a new MessageDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MessageDefinition"
}
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'
/MessageDefinition/_history:
get:
tags:
- MessageDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type MessageDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageDefinition/{id}/_history:
get:
tags:
- MessageDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MessageDefinition"
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'
/MessageDefinition/$validate:
get:
tags:
- MessageDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageDefinition/{id}/$validate:
get:
tags:
- MessageDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageDefinition/{id}/$meta-delete:
post:
tags:
- MessageDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageDefinition/{id}/$meta-add:
post:
tags:
- MessageDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageDefinition/$meta:
get:
tags:
- MessageDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageDefinition/{id}/$meta:
get:
tags:
- MessageDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageDefinition/$expunge:
post:
tags:
- MessageDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageDefinition/{id}/$expunge:
post:
tags:
- MessageDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageHeader/{id}:
get:
tags:
- MessageHeader
summary: "read-instance: Read MessageHeader 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:
- MessageHeader
summary: "update-instance: Update an existing MessageHeader 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": "MessageHeader"
}
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:
- MessageHeader
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:
- MessageHeader
summary: "instance-patch: Patch a resource instance of type MessageHeader 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'
/MessageHeader/{id}/_history/{version_id}:
get:
tags:
- MessageHeader
summary: "vread-instance: Read MessageHeader 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'
/MessageHeader:
get:
tags:
- MessageHeader
summary: "search-type: Search for MessageHeader instances"
description: This is a search type
parameters:
- name: code
in: query
description: ok | transient-error | fatal-error
style: simple
- name: receiver
in: query
description: Intended "real-world" recipient for the data
style: simple
- name: author
in: query
description: The source of the decision
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: destination
in: query
description: Name of system
style: simple
- name: focus
in: query
description: The actual content of the message
style: simple
- name: source
in: query
description: Name of system
style: simple
- name: target
in: query
description: Particular delivery destination within the destination
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: destination-uri
in: query
description: Actual destination address or id
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: sender
in: query
description: Real world sender of the message
style: simple
- name: source-uri
in: query
description: Actual message source address or id
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: responsible
in: query
description: Final responsibility for event
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: enterer
in: query
description: The source of the data entry
style: simple
- name: response-id
in: query
description: Id of original message
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: event
in: query
description: Code for the event this message represents or link to event definition
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- MessageHeader
summary: "create-type: Create a new MessageHeader instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MessageHeader"
}
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'
/MessageHeader/_history:
get:
tags:
- MessageHeader
summary: "type-history: Fetch the resource change history for all resources\
\ of type MessageHeader"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageHeader/{id}/_history:
get:
tags:
- MessageHeader
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MessageHeader"
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'
/MessageHeader/$validate:
get:
tags:
- MessageHeader
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageHeader/{id}/$validate:
get:
tags:
- MessageHeader
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageHeader/{id}/$meta-delete:
post:
tags:
- MessageHeader
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageHeader/{id}/$meta-add:
post:
tags:
- MessageHeader
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageHeader/$meta:
get:
tags:
- MessageHeader
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageHeader/{id}/$meta:
get:
tags:
- MessageHeader
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageHeader/$expunge:
post:
tags:
- MessageHeader
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MessageHeader/{id}/$expunge:
post:
tags:
- MessageHeader
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MolecularSequence/{id}:
get:
tags:
- MolecularSequence
summary: "read-instance: Read MolecularSequence 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:
- MolecularSequence
summary: "update-instance: Update an existing MolecularSequence 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": "MolecularSequence"
}
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:
- MolecularSequence
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:
- MolecularSequence
summary: "instance-patch: Patch a resource instance of type MolecularSequence\
\ 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'
/MolecularSequence/{id}/_history/{version_id}:
get:
tags:
- MolecularSequence
summary: "vread-instance: Read MolecularSequence 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'
/MolecularSequence:
get:
tags:
- MolecularSequence
summary: "search-type: Search for MolecularSequence instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The unique identity for a particular sequence
style: simple
- name: subject
in: query
description: The subject that the sequence is about
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: type
in: query
description: Amino Acid Sequence/ DNA Sequence / RNA Sequence
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: The subject that the sequence is about
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
responses:
"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:
- MolecularSequence
summary: "create-type: Create a new MolecularSequence instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "MolecularSequence"
}
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'
/MolecularSequence/_history:
get:
tags:
- MolecularSequence
summary: "type-history: Fetch the resource change history for all resources\
\ of type MolecularSequence"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MolecularSequence/{id}/_history:
get:
tags:
- MolecularSequence
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MolecularSequence"
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'
/MolecularSequence/$validate:
get:
tags:
- MolecularSequence
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MolecularSequence/{id}/$validate:
get:
tags:
- MolecularSequence
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MolecularSequence/{id}/$meta-delete:
post:
tags:
- MolecularSequence
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MolecularSequence/{id}/$meta-add:
post:
tags:
- MolecularSequence
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MolecularSequence/$meta:
get:
tags:
- MolecularSequence
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MolecularSequence/{id}/$meta:
get:
tags:
- MolecularSequence
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MolecularSequence/$expunge:
post:
tags:
- MolecularSequence
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/MolecularSequence/{id}/$expunge:
post:
tags:
- MolecularSequence
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NamingSystem/{id}:
get:
tags:
- NamingSystem
summary: "read-instance: Read NamingSystem 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:
- NamingSystem
summary: "update-instance: Update an existing NamingSystem 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": "NamingSystem"
}
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:
- NamingSystem
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:
- NamingSystem
summary: "instance-patch: Patch a resource instance of type NamingSystem 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'
/NamingSystem/{id}/_history/{version_id}:
get:
tags:
- NamingSystem
summary: "vread-instance: Read NamingSystem 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'
/NamingSystem:
get:
tags:
- NamingSystem
summary: "search-type: Search for NamingSystem instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: derived-from
in: query
description: A resource that the NamingSystem is derived from
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: predecessor
in: query
description: The predecessor of the NamingSystem
style: simple
- name: type
in: query
description: "e.g. driver, provider, patient, bank etc."
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: effective
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ The time during which the CodeSystem is intended to be in use\r\n* [ConceptMap](conceptmap.html):\
\ The time during which the ConceptMap is intended to be in use\r\n* [NamingSystem](namingsystem.html):\
\ The time during which the NamingSystem is intended to be in use\r\n* [ValueSet](valueset.html):\
\ The time during which the ValueSet is intended to be in use\r\n"
style: simple
- name: contact
in: query
description: Name of an individual to contact
style: simple
- name: responsible
in: query
description: Who maintains system namespace?
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: telecom
in: query
description: Contact details for individual or organization
style: simple
- name: value
in: query
description: The unique identifier
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ External identifier for the naming system\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ External identifier for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set\r\n"
style: simple
- name: period
in: query
description: When is identifier valid?
style: simple
- name: kind
in: query
description: codesystem | identifier | root
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: id-type
in: query
description: oid | uuid | uri | other
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: topic
in: query
description: Topics associated with the NamingSystem
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- NamingSystem
summary: "create-type: Create a new NamingSystem instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "NamingSystem"
}
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'
/NamingSystem/_history:
get:
tags:
- NamingSystem
summary: "type-history: Fetch the resource change history for all resources\
\ of type NamingSystem"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NamingSystem/{id}/_history:
get:
tags:
- NamingSystem
summary: "instance-history: Fetch the resource change history for all resources\
\ of type NamingSystem"
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'
/NamingSystem/$validate:
get:
tags:
- NamingSystem
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NamingSystem/{id}/$validate:
get:
tags:
- NamingSystem
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NamingSystem/{id}/$meta-delete:
post:
tags:
- NamingSystem
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NamingSystem/{id}/$meta-add:
post:
tags:
- NamingSystem
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NamingSystem/$meta:
get:
tags:
- NamingSystem
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NamingSystem/{id}/$meta:
get:
tags:
- NamingSystem
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NamingSystem/$expunge:
post:
tags:
- NamingSystem
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NamingSystem/{id}/$expunge:
post:
tags:
- NamingSystem
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionIntake/{id}:
get:
tags:
- NutritionIntake
summary: "read-instance: Read NutritionIntake 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:
- NutritionIntake
summary: "update-instance: Update an existing NutritionIntake 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": "NutritionIntake"
}
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:
- NutritionIntake
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:
- NutritionIntake
summary: "instance-patch: Patch a resource instance of type NutritionIntake\
\ 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'
/NutritionIntake/{id}/_history/{version_id}:
get:
tags:
- NutritionIntake
summary: "vread-instance: Read NutritionIntake 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'
/NutritionIntake:
get:
tags:
- NutritionIntake
summary: "search-type: Search for NutritionIntake instances"
description: This is a search type
parameters:
- name: date
in: query
description: Date when patient was taking (or not taking) the medication
style: simple
- name: identifier
in: query
description: Return statements with this external identifier
style: simple
- name: code
in: query
description: Returns statements of this code of NutritionIntake
style: simple
- name: subject
in: query
description: "The identity of a patient, animal or group to list statements\
\ for"
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: Returns statements for a specific encounter
style: simple
- name: source
in: query
description: Who or where the information in the statement came from
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: nutrition
in: query
description: Return intakes for a specific consumed item
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: Returns statements for a specific patient.
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: Return statements that match the given status
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- NutritionIntake
summary: "create-type: Create a new NutritionIntake instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "NutritionIntake"
}
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'
/NutritionIntake/_history:
get:
tags:
- NutritionIntake
summary: "type-history: Fetch the resource change history for all resources\
\ of type NutritionIntake"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionIntake/{id}/_history:
get:
tags:
- NutritionIntake
summary: "instance-history: Fetch the resource change history for all resources\
\ of type NutritionIntake"
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'
/NutritionIntake/$validate:
get:
tags:
- NutritionIntake
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionIntake/{id}/$validate:
get:
tags:
- NutritionIntake
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionIntake/{id}/$meta-delete:
post:
tags:
- NutritionIntake
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionIntake/{id}/$meta-add:
post:
tags:
- NutritionIntake
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionIntake/$meta:
get:
tags:
- NutritionIntake
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionIntake/{id}/$meta:
get:
tags:
- NutritionIntake
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionIntake/$expunge:
post:
tags:
- NutritionIntake
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionIntake/{id}/$expunge:
post:
tags:
- NutritionIntake
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionOrder/{id}:
get:
tags:
- NutritionOrder
summary: "read-instance: Read NutritionOrder 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:
- NutritionOrder
summary: "update-instance: Update an existing NutritionOrder 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": "NutritionOrder"
}
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:
- NutritionOrder
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:
- NutritionOrder
summary: "instance-patch: Patch a resource instance of type NutritionOrder 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'
/NutritionOrder/{id}/_history/{version_id}:
get:
tags:
- NutritionOrder
summary: "vread-instance: Read NutritionOrder 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'
/NutritionOrder:
get:
tags:
- NutritionOrder
summary: "search-type: Search for NutritionOrder instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: subject
in: query
description: "The identity of the individual or set of individuals who requires\
\ the diet, formula or nutritional supplement"
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [Composition](composition.html): Context\
\ of the Composition * [DeviceRequest](devicerequest.html): Encounter during\
\ which request was created * [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made * [Flag](flag.html): Alert relevant\
\ during encounter * [List](list.html): Context in which list created *\
\ [NutritionOrder](nutritionorder.html): Return nutrition orders with this\
\ encounter identifier * [Observation](observation.html): Encounter related\
\ to the observation * [Procedure](procedure.html): The Encounter during\
\ which this Procedure was created * [RiskAssessment](riskassessment.html):\
\ Where was assessment performed? * [ServiceRequest](servicerequest.html):\
\ An encounter in which this request is made * [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: oraldiet
in: query
description: "Type of diet that can be consumed orally (i.e., take via the\
\ mouth)."
style: simple
- name: additive
in: query
description: Type of module component to add to the feeding
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: datetime
in: query
description: Return nutrition orders requested on this date
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: provider
in: query
description: The identity of the provider who placed the nutrition order
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: supplement
in: query
description: Type of supplement product requested
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: formula
in: query
description: Type of enteral or infant formula
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: Status of the nutrition order.
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- NutritionOrder
summary: "create-type: Create a new NutritionOrder instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "NutritionOrder"
}
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'
/NutritionOrder/_history:
get:
tags:
- NutritionOrder
summary: "type-history: Fetch the resource change history for all resources\
\ of type NutritionOrder"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionOrder/{id}/_history:
get:
tags:
- NutritionOrder
summary: "instance-history: Fetch the resource change history for all resources\
\ of type NutritionOrder"
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'
/NutritionOrder/$validate:
get:
tags:
- NutritionOrder
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionOrder/{id}/$validate:
get:
tags:
- NutritionOrder
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionOrder/{id}/$meta-delete:
post:
tags:
- NutritionOrder
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionOrder/{id}/$meta-add:
post:
tags:
- NutritionOrder
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionOrder/$meta:
get:
tags:
- NutritionOrder
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionOrder/{id}/$meta:
get:
tags:
- NutritionOrder
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionOrder/$expunge:
post:
tags:
- NutritionOrder
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionOrder/{id}/$expunge:
post:
tags:
- NutritionOrder
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionProduct/{id}:
get:
tags:
- NutritionProduct
summary: "read-instance: Read NutritionProduct 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:
- NutritionProduct
summary: "update-instance: Update an existing NutritionProduct 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": "NutritionProduct"
}
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:
- NutritionProduct
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:
- NutritionProduct
summary: "instance-patch: Patch a resource instance of type NutritionProduct\
\ 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'
/NutritionProduct/{id}/_history/{version_id}:
get:
tags:
- NutritionProduct
summary: "vread-instance: Read NutritionProduct 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'
/NutritionProduct:
get:
tags:
- NutritionProduct
summary: "search-type: Search for NutritionProduct instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "The identifier for the physical instance, typically a serial\
\ number"
style: simple
- name: code
in: query
description: The code identifying a specific nutrition product
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The broad product group or category of the nutrition product
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- NutritionProduct
summary: "create-type: Create a new NutritionProduct instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "NutritionProduct"
}
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'
/NutritionProduct/_history:
get:
tags:
- NutritionProduct
summary: "type-history: Fetch the resource change history for all resources\
\ of type NutritionProduct"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionProduct/{id}/_history:
get:
tags:
- NutritionProduct
summary: "instance-history: Fetch the resource change history for all resources\
\ of type NutritionProduct"
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'
/NutritionProduct/$validate:
get:
tags:
- NutritionProduct
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionProduct/{id}/$validate:
get:
tags:
- NutritionProduct
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionProduct/{id}/$meta-delete:
post:
tags:
- NutritionProduct
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionProduct/{id}/$meta-add:
post:
tags:
- NutritionProduct
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionProduct/$meta:
get:
tags:
- NutritionProduct
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionProduct/{id}/$meta:
get:
tags:
- NutritionProduct
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionProduct/$expunge:
post:
tags:
- NutritionProduct
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/NutritionProduct/{id}/$expunge:
post:
tags:
- NutritionProduct
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/{id}:
get:
tags:
- Observation
summary: "read-instance: Read Observation instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Observation
summary: "update-instance: Update an existing Observation instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Observation"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Observation
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Observation
summary: "instance-patch: Patch a resource instance of type Observation by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/{id}/_history/{version_id}:
get:
tags:
- Observation
summary: "vread-instance: Read Observation instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation:
get:
tags:
- Observation
summary: "search-type: Search for Observation instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: combo-data-absent-reason
in: query
description: "The reason why the expected value in the element Observation.value[x]\
\ or Observation.component.value[x] is missing."
style: simple
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: component-data-absent-reason
in: query
description: "The reason why the expected value in the element Observation.component.value[x]\
\ is missing."
style: simple
- name: subject
in: query
description: The subject that the observation is about
style: simple
- name: combo-code-value-quantity
in: query
description: "Code and quantity value parameter pair, including in components"
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: value-concept
in: query
description: "The value of the observation, if the value is a CodeableConcept"
style: simple
- name: value-date
in: query
description: "The value of the observation, if the value is a date or period\
\ of time"
style: simple
- name: derived-from
in: query
description: Related measurements the observation is made from
style: simple
- name: focus
in: query
description: The focus of an observation when the focus is not the patient
of record.
style: simple
- name: part-of
in: query
description: Part of referenced event
style: simple
- name: has-member
in: query
description: Related resource that belongs to the Observation group
style: simple
- name: code-value-string
in: query
description: Code and string value parameter pair
style: simple
- name: component-code-value-quantity
in: query
description: Component code and component quantity value parameter pair
style: simple
- name: based-on
in: query
description: Reference to the service request.
style: simple
- name: code-value-date
in: query
description: Code and date/time value parameter pair
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: specimen
in: query
description: Specimen used for this observation
style: simple
- name: component-code
in: query
description: The component code of the observation type
style: simple
- name: code-value-quantity
in: query
description: Code and quantity value parameter pair
style: simple
- name: combo-code-value-concept
in: query
description: "Code and coded value parameter pair, including in components"
style: simple
- name: value-string
in: query
description: "The value of the observation, if the value is a string, and\
\ also searches in CodeableConcept.text"
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: performer
in: query
description: Who performed the observation
style: simple
- name: combo-code
in: query
description: The code of the observation type or component type
style: simple
- name: method
in: query
description: The method used for the observation
style: simple
- name: value-quantity
in: query
description: "The value of the observation, if the value is a Quantity, or\
\ a SampledData (just search on the bounds of the values in sampled data)"
style: simple
- name: component-value-quantity
in: query
description: "The value of the component observation, if the value is a Quantity,\
\ or a SampledData (just search on the bounds of the values in sampled data)"
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: data-absent-reason
in: query
description: "The reason why the expected value in the element Observation.value[x]\
\ is missing."
style: simple
- name: combo-value-quantity
in: query
description: "The value or component value of the observation, if the value\
\ is a Quantity, or a SampledData (just search on the bounds of the values\
\ in sampled data)"
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [Composition](composition.html): Context\
\ of the Composition * [DeviceRequest](devicerequest.html): Encounter during\
\ which request was created * [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made * [Flag](flag.html): Alert relevant\
\ during encounter * [List](list.html): Context in which list created *\
\ [NutritionOrder](nutritionorder.html): Return nutrition orders with this\
\ encounter identifier * [Observation](observation.html): Encounter related\
\ to the observation * [Procedure](procedure.html): The Encounter during\
\ which this Procedure was created * [RiskAssessment](riskassessment.html):\
\ Where was assessment performed? * [ServiceRequest](servicerequest.html):\
\ An encounter in which this request is made * [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: code-value-concept
in: query
description: Code and coded value parameter pair
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: component-code-value-concept
in: query
description: Component code and component coded value parameter pair
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: component-value-concept
in: query
description: "The value of the component observation, if the value is a CodeableConcept"
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: The classification of the type of observation
style: simple
- name: device
in: query
description: The Device that generated the observation data.
style: simple
- name: combo-value-concept
in: query
description: "The value or component value of the observation, if the value\
\ is a CodeableConcept"
style: simple
- name: status
in: query
description: The status of the observation
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Observation
summary: "create-type: Create a new Observation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Observation"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/_history:
get:
tags:
- Observation
summary: "type-history: Fetch the resource change history for all resources\
\ of type Observation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/{id}/_history:
get:
tags:
- Observation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Observation"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/$validate:
get:
tags:
- Observation
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/{id}/$validate:
get:
tags:
- Observation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/{id}/$meta-delete:
post:
tags:
- Observation
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/{id}/$meta-add:
post:
tags:
- Observation
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/$meta:
get:
tags:
- Observation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/{id}/$meta:
get:
tags:
- Observation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/$expunge:
post:
tags:
- Observation
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/{id}/$expunge:
post:
tags:
- Observation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Observation/$lastn:
get:
tags:
- Observation
parameters:
- name: _count
in: query
description: Results from this method are returned across multiple pages.
This parameter controls the size of those pages.
required: false
style: simple
- name: category
in: query
description: The classification of the type of observation
required: false
style: simple
- name: code
in: query
description: The code of the observation type
required: false
style: simple
- name: date
in: query
description: The effective date of the observation
required: false
style: simple
- name: patient
in: query
description: The subject that the observation is about (if patient)
required: false
style: simple
- name: subject
in: query
description: The subject that the observation is about
required: false
style: simple
- name: max
in: query
description: The maximum number of observations to return for each observation
code
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ObservationDefinition/{id}:
get:
tags:
- ObservationDefinition
summary: "read-instance: Read ObservationDefinition 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:
- ObservationDefinition
summary: "update-instance: Update an existing ObservationDefinition 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": "ObservationDefinition"
}
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:
- ObservationDefinition
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:
- ObservationDefinition
summary: "instance-patch: Patch a resource instance of type ObservationDefinition\
\ 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'
/ObservationDefinition/{id}/_history/{version_id}:
get:
tags:
- ObservationDefinition
summary: "vread-instance: Read ObservationDefinition 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'
/ObservationDefinition:
get:
tags:
- ObservationDefinition
summary: "search-type: Search for ObservationDefinition instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The unique identifier associated with the specimen definition
style: simple
- name: code
in: query
description: Observation code
style: simple
- name: method
in: query
description: Method of observation
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: experimental
in: query
description: Not for genuine usage (true)
style: simple
- name: title
in: query
description: Human-friendly name of the ObservationDefinition
style: simple
- name: url
in: query
description: The uri that identifies the observation definition
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: Category (class) of observation
style: simple
- name: status
in: query
description: "Publication status of the ObservationDefinition: draft, active,\
\ retired, unknown"
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ObservationDefinition
summary: "create-type: Create a new ObservationDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ObservationDefinition"
}
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'
/ObservationDefinition/_history:
get:
tags:
- ObservationDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type ObservationDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ObservationDefinition/{id}/_history:
get:
tags:
- ObservationDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ObservationDefinition"
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'
/ObservationDefinition/$validate:
get:
tags:
- ObservationDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ObservationDefinition/{id}/$validate:
get:
tags:
- ObservationDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ObservationDefinition/{id}/$meta-delete:
post:
tags:
- ObservationDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ObservationDefinition/{id}/$meta-add:
post:
tags:
- ObservationDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ObservationDefinition/$meta:
get:
tags:
- ObservationDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ObservationDefinition/{id}/$meta:
get:
tags:
- ObservationDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ObservationDefinition/$expunge:
post:
tags:
- ObservationDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ObservationDefinition/{id}/$expunge:
post:
tags:
- ObservationDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/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'
put:
tags:
- OperationDefinition
summary: "update-instance: Update an existing OperationDefinition instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "OperationDefinition"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- OperationDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "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:
- OperationDefinition
summary: "instance-patch: Patch a resource instance of type OperationDefinition\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "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'
/OperationDefinition/{id}/_history/{version_id}:
get:
tags:
- OperationDefinition
summary: "vread-instance: Read OperationDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "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'
/OperationDefinition:
get:
tags:
- OperationDefinition
summary: "search-type: Search for OperationDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: code
in: query
description: Name used to invoke the operation
style: simple
- name: instance
in: query
description: Invoke on an instance?
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: title
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system * [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map * [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition * [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition * [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition * [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ The human-friendly name of the value set "
style: simple
- name: type
in: query
description: Invoke at the type level?
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: output-profile
in: query
description: Validation information for out parameters
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: kind
in: query
description: operation | query
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: input-profile
in: query
description: Validation information for in parameters
style: simple
- name: system
in: query
description: Invoke at the system level?
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
- name: base
in: query
description: Marks this as a profile of the base
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- OperationDefinition
summary: "create-type: Create a new OperationDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "OperationDefinition"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/_history:
get:
tags:
- OperationDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type OperationDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/{id}/_history:
get:
tags:
- OperationDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type OperationDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "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/$validate:
get:
tags:
- OperationDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/{id}/$validate:
get:
tags:
- OperationDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/{id}/$meta-delete:
post:
tags:
- OperationDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/{id}/$meta-add:
post:
tags:
- OperationDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/$meta:
get:
tags:
- OperationDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/{id}/$meta:
get:
tags:
- OperationDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/$expunge:
post:
tags:
- OperationDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationDefinition/{id}/$expunge:
post:
tags:
- OperationDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationOutcome/{id}:
get:
tags:
- OperationOutcome
summary: "read-instance: Read OperationOutcome 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:
- OperationOutcome
summary: "update-instance: Update an existing OperationOutcome 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": "OperationOutcome",
"text": {
"status": "generated",
"div": "
Operation Outcome
"
}
}
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:
- OperationOutcome
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:
- OperationOutcome
summary: "instance-patch: Patch a resource instance of type OperationOutcome\
\ 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'
/OperationOutcome/{id}/_history/{version_id}:
get:
tags:
- OperationOutcome
summary: "vread-instance: Read OperationOutcome 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'
/OperationOutcome:
get:
tags:
- OperationOutcome
summary: "search-type: Search for OperationOutcome instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- OperationOutcome
summary: "create-type: Create a new OperationOutcome instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "OperationOutcome",
"text": {
"status": "generated",
"div": "Operation Outcome
"
}
}
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'
/OperationOutcome/_history:
get:
tags:
- OperationOutcome
summary: "type-history: Fetch the resource change history for all resources\
\ of type OperationOutcome"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationOutcome/{id}/_history:
get:
tags:
- OperationOutcome
summary: "instance-history: Fetch the resource change history for all resources\
\ of type OperationOutcome"
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'
/OperationOutcome/$validate:
get:
tags:
- OperationOutcome
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationOutcome/{id}/$validate:
get:
tags:
- OperationOutcome
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationOutcome/{id}/$meta-delete:
post:
tags:
- OperationOutcome
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationOutcome/{id}/$meta-add:
post:
tags:
- OperationOutcome
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationOutcome/$meta:
get:
tags:
- OperationOutcome
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationOutcome/{id}/$meta:
get:
tags:
- OperationOutcome
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationOutcome/$expunge:
post:
tags:
- OperationOutcome
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OperationOutcome/{id}/$expunge:
post:
tags:
- OperationOutcome
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}:
get:
tags:
- Organization
summary: "read-instance: Read Organization instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Organization
summary: "update-instance: Update an existing Organization instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Organization"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Organization
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Organization
summary: "instance-patch: Patch a resource instance of type Organization by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/_history/{version_id}:
get:
tags:
- Organization
summary: "vread-instance: Read Organization instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization:
get:
tags:
- Organization
summary: "search-type: Search for Organization instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Any identifier for the organization (not the accreditation issuer's
identifier)
style: simple
- name: partof
in: query
description: An organization of which this organization forms a part
style: simple
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
style: simple
- name: address-state
in: query
description: A state specified in an address
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: Is the Organization record active
style: simple
- name: type
in: query
description: A code for the type of organization
style: simple
- name: address-postalcode
in: query
description: A postal code specified in an address
style: simple
- name: address-country
in: query
description: A country specified in an address
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the organization
style: simple
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: address-use
in: query
description: A use code specified in an address
style: simple
- name: name
in: query
description: A portion of the organization's name or alias
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: address-city
in: query
description: A city specified in an address
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Organization
summary: "create-type: Create a new Organization instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Organization"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/_history:
get:
tags:
- Organization
summary: "type-history: Fetch the resource change history for all resources\
\ of type Organization"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/_history:
get:
tags:
- Organization
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Organization"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/$validate:
get:
tags:
- Organization
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$validate:
get:
tags:
- Organization
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$meta-delete:
post:
tags:
- Organization
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$meta-add:
post:
tags:
- Organization
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/$meta:
get:
tags:
- Organization
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$meta:
get:
tags:
- Organization
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/$expunge:
post:
tags:
- Organization
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Organization/{id}/$expunge:
post:
tags:
- Organization
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/{id}:
get:
tags:
- OrganizationAffiliation
summary: "read-instance: Read OrganizationAffiliation instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- OrganizationAffiliation
summary: "update-instance: Update an existing OrganizationAffiliation instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "OrganizationAffiliation"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- OrganizationAffiliation
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- OrganizationAffiliation
summary: "instance-patch: Patch a resource instance of type OrganizationAffiliation\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/{id}/_history/{version_id}:
get:
tags:
- OrganizationAffiliation
summary: "vread-instance: Read OrganizationAffiliation instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation:
get:
tags:
- OrganizationAffiliation
summary: "search-type: Search for OrganizationAffiliation instances"
description: This is a search type
parameters:
- name: date
in: query
description: The period during which the participatingOrganization is affiliated
with the primary organization
style: simple
- name: identifier
in: query
description: An organization affiliation's Identifier
style: simple
- name: specialty
in: query
description: Specific specialty of the participatingOrganization in the context
of the role
style: simple
- name: role
in: query
description: Definition of the role the participatingOrganization plays
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: Whether this organization affiliation record is in active use
style: simple
- name: primary-organization
in: query
description: The organization that receives the services from the participating
organization
style: simple
- name: network
in: query
description: Health insurance provider network in which the participatingOrganization
provides the role's services (if defined) at the indicated locations (if
defined)
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
this role
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: phone
in: query
description: A value in a phone contact
style: simple
- name: service
in: query
description: Healthcare services provided through the role
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: participating-organization
in: query
description: The organization that provides services to the primary organization
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: The location(s) at which the role occurs
style: simple
- name: telecom
in: query
description: The value in any kind of contact
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: email
in: query
description: A value in an email contact
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- OrganizationAffiliation
summary: "create-type: Create a new OrganizationAffiliation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "OrganizationAffiliation"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/_history:
get:
tags:
- OrganizationAffiliation
summary: "type-history: Fetch the resource change history for all resources\
\ of type OrganizationAffiliation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/{id}/_history:
get:
tags:
- OrganizationAffiliation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type OrganizationAffiliation"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/$validate:
get:
tags:
- OrganizationAffiliation
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/{id}/$validate:
get:
tags:
- OrganizationAffiliation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/{id}/$meta-delete:
post:
tags:
- OrganizationAffiliation
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/{id}/$meta-add:
post:
tags:
- OrganizationAffiliation
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/$meta:
get:
tags:
- OrganizationAffiliation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/{id}/$meta:
get:
tags:
- OrganizationAffiliation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/$expunge:
post:
tags:
- OrganizationAffiliation
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/OrganizationAffiliation/{id}/$expunge:
post:
tags:
- OrganizationAffiliation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PackagedProductDefinition/{id}:
get:
tags:
- PackagedProductDefinition
summary: "read-instance: Read PackagedProductDefinition 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:
- PackagedProductDefinition
summary: "update-instance: Update an existing PackagedProductDefinition 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": "PackagedProductDefinition"
}
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:
- PackagedProductDefinition
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:
- PackagedProductDefinition
summary: "instance-patch: Patch a resource instance of type PackagedProductDefinition\
\ 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'
/PackagedProductDefinition/{id}/_history/{version_id}:
get:
tags:
- PackagedProductDefinition
summary: "vread-instance: Read PackagedProductDefinition 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'
/PackagedProductDefinition:
get:
tags:
- PackagedProductDefinition
summary: "search-type: Search for PackagedProductDefinition instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Unique identifier
style: simple
- name: package
in: query
description: A complete packaged product within this packaged product
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: medication
in: query
description: A manufactured item of medication within this packaged product
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: manufactured-item
in: query
description: A manufactured item of medication within this packaged product
style: simple
- name: nutrition
in: query
description: A nutrition product within this packaged product
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "A name for this package. Typically what it would be listed as\
\ in a drug formulary or catalogue, inventory etc"
style: simple
- name: biological
in: query
description: A biologically derived product within this packaged product
style: simple
- name: package-for
in: query
description: The product that this is a pack for
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: contained-item
in: query
description: Any of the contained items within this packaged product
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: device
in: query
description: A device within this packaged product
style: simple
- name: status
in: query
description: "The status within the lifecycle of this item. A high level status,\
\ this is not intended to duplicate details carried elsewhere such as legal\
\ status, or authorization or marketing status"
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PackagedProductDefinition
summary: "create-type: Create a new PackagedProductDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "PackagedProductDefinition"
}
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'
/PackagedProductDefinition/_history:
get:
tags:
- PackagedProductDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type PackagedProductDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PackagedProductDefinition/{id}/_history:
get:
tags:
- PackagedProductDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PackagedProductDefinition"
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'
/PackagedProductDefinition/$validate:
get:
tags:
- PackagedProductDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PackagedProductDefinition/{id}/$validate:
get:
tags:
- PackagedProductDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PackagedProductDefinition/{id}/$meta-delete:
post:
tags:
- PackagedProductDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PackagedProductDefinition/{id}/$meta-add:
post:
tags:
- PackagedProductDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PackagedProductDefinition/$meta:
get:
tags:
- PackagedProductDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PackagedProductDefinition/{id}/$meta:
get:
tags:
- PackagedProductDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PackagedProductDefinition/$expunge:
post:
tags:
- PackagedProductDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PackagedProductDefinition/{id}/$expunge:
post:
tags:
- PackagedProductDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Parameters/{id}:
get:
tags:
- Parameters
summary: "read-instance: Read Parameters 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:
- Parameters
summary: "update-instance: Update an existing Parameters 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": "Parameters"
}
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:
- Parameters
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:
- Parameters
summary: "instance-patch: Patch a resource instance of type Parameters 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'
/Parameters/{id}/_history/{version_id}:
get:
tags:
- Parameters
summary: "vread-instance: Read Parameters 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'
/Parameters:
get:
tags:
- Parameters
summary: "search-type: Search for Parameters instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Parameters
summary: "create-type: Create a new Parameters instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters"
}
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'
/Parameters/_history:
get:
tags:
- Parameters
summary: "type-history: Fetch the resource change history for all resources\
\ of type 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'
/Parameters/{id}/_history:
get:
tags:
- Parameters
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Parameters"
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'
/Parameters/$validate:
get:
tags:
- Parameters
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Parameters/{id}/$validate:
get:
tags:
- Parameters
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Parameters/{id}/$meta-delete:
post:
tags:
- Parameters
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Parameters/{id}/$meta-add:
post:
tags:
- Parameters
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Parameters/$meta:
get:
tags:
- Parameters
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Parameters/{id}/$meta:
get:
tags:
- Parameters
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Parameters/$expunge:
post:
tags:
- Parameters
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Parameters/{id}/$expunge:
post:
tags:
- Parameters
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/{id}:
get:
tags:
- Patient
summary: "read-instance: Read Patient instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Patient
summary: "update-instance: Update an existing Patient instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Patient",
"text": {
"status": "generated",
"div": ""
}
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Patient
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Patient
summary: "instance-patch: Patch a resource instance of type Patient by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/{id}/_history/{version_id}:
get:
tags:
- Patient
summary: "vread-instance: Read Patient instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient:
get:
tags:
- Patient
summary: "search-type: Search for Patient instances"
description: This is a search type
parameters:
- name: birthdate
in: query
description: "Multiple Resources: * [Patient](patient.html): The patient's\
\ date of birth * [Person](person.html): The person's date of birth * [RelatedPerson](relatedperson.html):\
\ The Related Person's date of birth "
style: simple
- name: deceased
in: query
description: "This patient has been marked as deceased, or has a death date\
\ entered"
style: simple
- name: address-state
in: query
description: "Multiple Resources: * [Patient](patient.html): A state specified\
\ in an address * [Person](person.html): A state specified in an address\
\ * [Practitioner](practitioner.html): A state specified in an address *\
\ [RelatedPerson](relatedperson.html): A state specified in an address "
style: simple
- name: gender
in: query
description: "Multiple Resources: * [Patient](patient.html): Gender of the\
\ patient * [Person](person.html): The gender of the person * [Practitioner](practitioner.html):\
\ Gender of the practitioner * [RelatedPerson](relatedperson.html): Gender\
\ of the related person "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: link
in: query
description: All patients linked to the given patient
style: simple
- name: language
in: query
description: Language code (irrespective of use value)
style: simple
- name: mothersMaidenName
in: query
description: Search based on patient's mother's maiden name
style: simple
- name: address-country
in: query
description: "Multiple Resources: * [Patient](patient.html): A country specified\
\ in an address * [Person](person.html): A country specified in an address\
\ * [Practitioner](practitioner.html): A country specified in an address\
\ * [RelatedPerson](relatedperson.html): A country specified in an address "
style: simple
- name: death-date
in: query
description: The date of death has been provided and satisfies this search
value
style: simple
- name: phonetic
in: query
description: "Multiple Resources: * [Patient](patient.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\
\ * [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm * [Practitioner](practitioner.html): A portion of either\
\ family or given name using some kind of phonetic matching algorithm *\
\ [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm "
style: simple
- name: telecom
in: query
description: "Multiple Resources: * [Patient](patient.html): The value in\
\ any kind of telecom details of the patient * [Person](person.html): The\
\ value in any kind of contact * [Practitioner](practitioner.html): The\
\ value in any kind of contact * [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact * [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact "
style: simple
- name: address-city
in: query
description: "Multiple Resources: * [Patient](patient.html): A city specified\
\ in an address * [Person](person.html): A city specified in an address\
\ * [Practitioner](practitioner.html): A city specified in an address *\
\ [RelatedPerson](relatedperson.html): A city specified in an address "
style: simple
- name: email
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ an email contact * [Person](person.html): A value in an email contact\
\ * [Practitioner](practitioner.html): A value in an email contact * [PractitionerRole](practitionerrole.html):\
\ A value in an email contact * [RelatedPerson](relatedperson.html): A value\
\ in an email contact "
style: simple
- name: given
in: query
description: "Multiple Resources: * [Patient](patient.html): A portion of\
\ the given name of the patient * [Practitioner](practitioner.html): A portion\
\ of the given name "
style: simple
- name: identifier
in: query
description: A patient identifier
style: simple
- name: address
in: query
description: "Multiple Resources: * [Patient](patient.html): A server defined\
\ search that may match any of the string fields in the Address, including\
\ line, city, district, state, country, postalCode, and/or text * [Person](person.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text * [Practitioner](practitioner.html): A server defined search that\
\ may match any of the string fields in the Address, including line, city,\
\ district, state, country, postalCode, and/or text * [RelatedPerson](relatedperson.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text "
style: simple
- name: birthOrderBoolean
in: query
description: Search based on whether a patient was part of a multiple birth
or not.
style: simple
- name: general-practitioner
in: query
description: "Patient's nominated general practitioner, not the organization\
\ that manages the record"
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: Whether the patient record is active
style: simple
- name: part-agree
in: query
description: "Search by url for a participation agreement, which is stored\
\ in a DocumentReference"
style: simple
- name: address-postalcode
in: query
description: "Multiple Resources: * [Patient](patient.html): A postalCode\
\ specified in an address * [Person](person.html): A postal code specified\
\ in an address * [Practitioner](practitioner.html): A postalCode specified\
\ in an address * [RelatedPerson](relatedperson.html): A postal code specified\
\ in an address "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: phone
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ a phone contact * [Person](person.html): A value in a phone contact *\
\ [Practitioner](practitioner.html): A value in a phone contact * [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact * [RelatedPerson](relatedperson.html): A value\
\ in a phone contact "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: organization
in: query
description: The organization that is the custodian of the patient record
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: address-use
in: query
description: "Multiple Resources: * [Patient](patient.html): A use code\
\ specified in an address * [Person](person.html): A use code specified\
\ in an address * [Practitioner](practitioner.html): A use code specified\
\ in an address * [RelatedPerson](relatedperson.html): A use code specified\
\ in an address "
style: simple
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, given, prefix, suffix, and/or text"
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: family
in: query
description: "Multiple Resources: * [Patient](patient.html): A portion of\
\ the family name of the patient * [Practitioner](practitioner.html): A\
\ portion of the family name "
style: simple
- name: age
in: query
description: Searches for patients based on age as calculated based on current
date and date of birth. Deceased patients are excluded from the search.
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Patient
summary: "create-type: Create a new Patient instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Patient",
"text": {
"status": "generated",
"div": ""
}
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/_history:
get:
tags:
- Patient
summary: "type-history: Fetch the resource change history for all resources\
\ of type Patient"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/{id}/_history:
get:
tags:
- Patient
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Patient"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/$validate:
get:
tags:
- Patient
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/{id}/$validate:
get:
tags:
- Patient
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/{id}/$meta-delete:
post:
tags:
- Patient
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/{id}/$meta-add:
post:
tags:
- Patient
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/$meta:
get:
tags:
- Patient
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/{id}/$meta:
get:
tags:
- Patient
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/$expunge:
post:
tags:
- Patient
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/{id}/$expunge:
post:
tags:
- Patient
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/$everything:
get:
tags:
- Patient
parameters:
- name: _count
in: query
description: Results from this method are returned across multiple pages.
This parameter controls the size of those pages.
required: false
style: simple
- name: _offset
in: query
description: Results from this method are returned across multiple pages.
This parameter controls the offset when fetching a page.
required: false
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by
the given range
required: false
style: simple
- name: _content
in: query
description: "Filter the resources to return only resources matching the given\
\ _content filter (note that this filter is applied only to results which\
\ link to the given patient, not to the patient itself or to supporting\
\ resources linked to by the matched resources)"
required: false
style: simple
- name: _text
in: query
description: "Filter the resources to return only resources matching the given\
\ _text filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
style: simple
- name: _filter
in: query
description: "Filter the resources to return only resources matching the given\
\ _filter filter (note that this filter is applied only to results which\
\ link to the given patient, not to the patient itself or to supporting\
\ resources linked to by the matched resources)"
required: false
style: simple
- name: _type
in: query
description: "Filter the resources to return only resources matching the given\
\ _type filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
style: simple
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Patient/{id}/$everything:
get:
tags:
- Patient
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: _count
in: query
description: Results from this method are returned across multiple pages.
This parameter controls the size of those pages.
required: false
style: simple
- name: _offset
in: query
description: Results from this method are returned across multiple pages.
This parameter controls the offset when fetching a page.
required: false
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by
the given range
required: false
style: simple
- name: _content
in: query
description: "Filter the resources to return only resources matching the given\
\ _content filter (note that this filter is applied only to results which\
\ link to the given patient, not to the patient itself or to supporting\
\ resources linked to by the matched resources)"
required: false
style: simple
- name: _text
in: query
description: "Filter the resources to return only resources matching the given\
\ _text filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
style: simple
- name: _filter
in: query
description: "Filter the resources to return only resources matching the given\
\ _filter filter (note that this filter is applied only to results which\
\ link to the given patient, not to the patient itself or to supporting\
\ resources linked to by the matched resources)"
required: false
style: simple
- name: _type
in: query
description: "Filter the resources to return only resources matching the given\
\ _type filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
style: simple
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentNotice/{id}:
get:
tags:
- PaymentNotice
summary: "read-instance: Read PaymentNotice 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:
- PaymentNotice
summary: "update-instance: Update an existing PaymentNotice 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": "PaymentNotice"
}
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:
- PaymentNotice
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:
- PaymentNotice
summary: "instance-patch: Patch a resource instance of type PaymentNotice 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'
/PaymentNotice/{id}/_history/{version_id}:
get:
tags:
- PaymentNotice
summary: "vread-instance: Read PaymentNotice 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'
/PaymentNotice:
get:
tags:
- PaymentNotice
summary: "search-type: Search for PaymentNotice instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the notice
style: simple
- name: request
in: query
description: The Claim
style: simple
- name: created
in: query
description: Creation date fro the notice
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: payment-status
in: query
description: The type of payment notice
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: provider
in: query
description: The reference to the provider
style: simple
- name: response
in: query
description: The ClaimResponse
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of the payment notice
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PaymentNotice
summary: "create-type: Create a new PaymentNotice instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "PaymentNotice"
}
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'
/PaymentNotice/_history:
get:
tags:
- PaymentNotice
summary: "type-history: Fetch the resource change history for all resources\
\ of type PaymentNotice"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentNotice/{id}/_history:
get:
tags:
- PaymentNotice
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PaymentNotice"
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'
/PaymentNotice/$validate:
get:
tags:
- PaymentNotice
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentNotice/{id}/$validate:
get:
tags:
- PaymentNotice
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentNotice/{id}/$meta-delete:
post:
tags:
- PaymentNotice
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentNotice/{id}/$meta-add:
post:
tags:
- PaymentNotice
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentNotice/$meta:
get:
tags:
- PaymentNotice
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentNotice/{id}/$meta:
get:
tags:
- PaymentNotice
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentNotice/$expunge:
post:
tags:
- PaymentNotice
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentNotice/{id}/$expunge:
post:
tags:
- PaymentNotice
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentReconciliation/{id}:
get:
tags:
- PaymentReconciliation
summary: "read-instance: Read PaymentReconciliation 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:
- PaymentReconciliation
summary: "update-instance: Update an existing PaymentReconciliation 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": "PaymentReconciliation"
}
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:
- PaymentReconciliation
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:
- PaymentReconciliation
summary: "instance-patch: Patch a resource instance of type PaymentReconciliation\
\ 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'
/PaymentReconciliation/{id}/_history/{version_id}:
get:
tags:
- PaymentReconciliation
summary: "vread-instance: Read PaymentReconciliation 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'
/PaymentReconciliation:
get:
tags:
- PaymentReconciliation
summary: "search-type: Search for PaymentReconciliation instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the ExplanationOfBenefit
style: simple
- name: request
in: query
description: The reference to the claim
style: simple
- name: created
in: query
description: The creation date
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: requestor
in: query
description: The reference to the provider who submitted the claim
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: disposition
in: query
description: The contents of the disposition message
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: allocation-encounter
in: query
description: The encounter to which payment or adjustment was applied.
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: allocation-account
in: query
description: The account to which payment or adjustment was applied.
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: outcome
in: query
description: The processing outcome
style: simple
- name: payment-issuer
in: query
description: The organization which generated this resource
style: simple
- name: status
in: query
description: The status of the payment reconciliation
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PaymentReconciliation
summary: "create-type: Create a new PaymentReconciliation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "PaymentReconciliation"
}
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'
/PaymentReconciliation/_history:
get:
tags:
- PaymentReconciliation
summary: "type-history: Fetch the resource change history for all resources\
\ of type PaymentReconciliation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentReconciliation/{id}/_history:
get:
tags:
- PaymentReconciliation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PaymentReconciliation"
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'
/PaymentReconciliation/$validate:
get:
tags:
- PaymentReconciliation
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentReconciliation/{id}/$validate:
get:
tags:
- PaymentReconciliation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentReconciliation/{id}/$meta-delete:
post:
tags:
- PaymentReconciliation
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentReconciliation/{id}/$meta-add:
post:
tags:
- PaymentReconciliation
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentReconciliation/$meta:
get:
tags:
- PaymentReconciliation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentReconciliation/{id}/$meta:
get:
tags:
- PaymentReconciliation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentReconciliation/$expunge:
post:
tags:
- PaymentReconciliation
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PaymentReconciliation/{id}/$expunge:
post:
tags:
- PaymentReconciliation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Permission/{id}:
get:
tags:
- Permission
summary: "read-instance: Read Permission 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:
- Permission
summary: "update-instance: Update an existing Permission 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": "Permission"
}
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:
- Permission
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:
- Permission
summary: "instance-patch: Patch a resource instance of type Permission 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'
/Permission/{id}/_history/{version_id}:
get:
tags:
- Permission
summary: "vread-instance: Read Permission 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'
/Permission:
get:
tags:
- Permission
summary: "search-type: Search for Permission instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: active | entered-in-error | draft | rejected
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Permission
summary: "create-type: Create a new Permission instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Permission"
}
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'
/Permission/_history:
get:
tags:
- Permission
summary: "type-history: Fetch the resource change history for all resources\
\ of type Permission"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Permission/{id}/_history:
get:
tags:
- Permission
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Permission"
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'
/Permission/$validate:
get:
tags:
- Permission
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Permission/{id}/$validate:
get:
tags:
- Permission
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Permission/{id}/$meta-delete:
post:
tags:
- Permission
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Permission/{id}/$meta-add:
post:
tags:
- Permission
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Permission/$meta:
get:
tags:
- Permission
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Permission/{id}/$meta:
get:
tags:
- Permission
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Permission/$expunge:
post:
tags:
- Permission
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Permission/{id}/$expunge:
post:
tags:
- Permission
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Person/{id}:
get:
tags:
- Person
summary: "read-instance: Read Person 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:
- Person
summary: "update-instance: Update an existing Person 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": "Person"
}
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:
- Person
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:
- Person
summary: "instance-patch: Patch a resource instance of type Person 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'
/Person/{id}/_history/{version_id}:
get:
tags:
- Person
summary: "vread-instance: Read Person 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'
/Person:
get:
tags:
- Person
summary: "search-type: Search for Person instances"
description: This is a search type
parameters:
- name: birthdate
in: query
description: "Multiple Resources: * [Patient](patient.html): The patient's\
\ date of birth * [Person](person.html): The person's date of birth * [RelatedPerson](relatedperson.html):\
\ The Related Person's date of birth "
style: simple
- name: deceased
in: query
description: "This person has been marked as deceased, or has a death date\
\ entered"
style: simple
- name: address-state
in: query
description: "Multiple Resources: * [Patient](patient.html): A state specified\
\ in an address * [Person](person.html): A state specified in an address\
\ * [Practitioner](practitioner.html): A state specified in an address *\
\ [RelatedPerson](relatedperson.html): A state specified in an address "
style: simple
- name: gender
in: query
description: "Multiple Resources: * [Patient](patient.html): Gender of the\
\ patient * [Person](person.html): The gender of the person * [Practitioner](practitioner.html):\
\ Gender of the practitioner * [RelatedPerson](relatedperson.html): Gender\
\ of the related person "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: link
in: query
description: "Any link has this Patient, Person, RelatedPerson or Practitioner\
\ reference"
style: simple
- name: address-country
in: query
description: "Multiple Resources: * [Patient](patient.html): A country specified\
\ in an address * [Person](person.html): A country specified in an address\
\ * [Practitioner](practitioner.html): A country specified in an address\
\ * [RelatedPerson](relatedperson.html): A country specified in an address "
style: simple
- name: death-date
in: query
description: The date of death has been provided and satisfies this search
value
style: simple
- name: phonetic
in: query
description: "Multiple Resources: * [Patient](patient.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\
\ * [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm * [Practitioner](practitioner.html): A portion of either\
\ family or given name using some kind of phonetic matching algorithm *\
\ [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm "
style: simple
- name: patient
in: query
description: The Person links to this Patient
style: simple
- name: telecom
in: query
description: "Multiple Resources: * [Patient](patient.html): The value in\
\ any kind of telecom details of the patient * [Person](person.html): The\
\ value in any kind of contact * [Practitioner](practitioner.html): The\
\ value in any kind of contact * [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact * [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact "
style: simple
- name: address-city
in: query
description: "Multiple Resources: * [Patient](patient.html): A city specified\
\ in an address * [Person](person.html): A city specified in an address\
\ * [Practitioner](practitioner.html): A city specified in an address *\
\ [RelatedPerson](relatedperson.html): A city specified in an address "
style: simple
- name: email
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ an email contact * [Person](person.html): A value in an email contact\
\ * [Practitioner](practitioner.html): A value in an email contact * [PractitionerRole](practitionerrole.html):\
\ A value in an email contact * [RelatedPerson](relatedperson.html): A value\
\ in an email contact "
style: simple
- name: given
in: query
description: A portion of the given name of the person
style: simple
- name: identifier
in: query
description: A person Identifier
style: simple
- name: address
in: query
description: "Multiple Resources: * [Patient](patient.html): A server defined\
\ search that may match any of the string fields in the Address, including\
\ line, city, district, state, country, postalCode, and/or text * [Person](person.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text * [Practitioner](practitioner.html): A server defined search that\
\ may match any of the string fields in the Address, including line, city,\
\ district, state, country, postalCode, and/or text * [RelatedPerson](relatedperson.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text "
style: simple
- name: practitioner
in: query
description: The Person links to this Practitioner
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: relatedperson
in: query
description: The Person links to this RelatedPerson
style: simple
- name: address-postalcode
in: query
description: "Multiple Resources: * [Patient](patient.html): A postalCode\
\ specified in an address * [Person](person.html): A postal code specified\
\ in an address * [Practitioner](practitioner.html): A postalCode specified\
\ in an address * [RelatedPerson](relatedperson.html): A postal code specified\
\ in an address "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: phone
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ a phone contact * [Person](person.html): A value in a phone contact *\
\ [Practitioner](practitioner.html): A value in a phone contact * [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact * [RelatedPerson](relatedperson.html): A value\
\ in a phone contact "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: organization
in: query
description: The organization at which this person record is being managed
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: address-use
in: query
description: "Multiple Resources: * [Patient](patient.html): A use code\
\ specified in an address * [Person](person.html): A use code specified\
\ in an address * [Practitioner](practitioner.html): A use code specified\
\ in an address * [RelatedPerson](relatedperson.html): A use code specified\
\ in an address "
style: simple
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: family
in: query
description: A portion of the family name of the person
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Person
summary: "create-type: Create a new Person instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Person"
}
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'
/Person/_history:
get:
tags:
- Person
summary: "type-history: Fetch the resource change history for all resources\
\ of type Person"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Person/{id}/_history:
get:
tags:
- Person
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Person"
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'
/Person/$validate:
get:
tags:
- Person
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Person/{id}/$validate:
get:
tags:
- Person
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Person/{id}/$meta-delete:
post:
tags:
- Person
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Person/{id}/$meta-add:
post:
tags:
- Person
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Person/$meta:
get:
tags:
- Person
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Person/{id}/$meta:
get:
tags:
- Person
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Person/$expunge:
post:
tags:
- Person
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Person/{id}/$expunge:
post:
tags:
- Person
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PlanDefinition/{id}:
get:
tags:
- PlanDefinition
summary: "read-instance: Read PlanDefinition 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:
- PlanDefinition
summary: "update-instance: Update an existing PlanDefinition 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": "PlanDefinition"
}
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:
- PlanDefinition
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:
- PlanDefinition
summary: "instance-patch: Patch a resource instance of type PlanDefinition 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'
/PlanDefinition/{id}/_history/{version_id}:
get:
tags:
- PlanDefinition
summary: "vread-instance: Read PlanDefinition 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'
/PlanDefinition:
get:
tags:
- PlanDefinition
summary: "search-type: Search for PlanDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The plan definition publication date
style: simple
- name: successor
in: query
description: What resource is being referenced
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the plan definition
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: Intended jurisdiction for the plan definition
style: simple
- name: derived-from
in: query
description: What resource is being referenced
style: simple
- name: description
in: query
description: The description of the plan definition
style: simple
- name: context-type
in: query
description: A type of use context assigned to the plan definition
style: simple
- name: predecessor
in: query
description: What resource is being referenced
style: simple
- name: composed-of
in: query
description: What resource is being referenced
style: simple
- name: title
in: query
description: The human-friendly name of the plan definition
style: simple
- name: type
in: query
description: "The type of artifact the plan (e.g. order-set, eca-rule, protocol)"
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the plan
definition
style: simple
- name: depends-on
in: query
description: What resource is being referenced
style: simple
- name: effective
in: query
description: The time during which the plan definition is intended to be in
use
style: simple
- name: context
in: query
description: A use context assigned to the plan definition
style: simple
- name: definition
in: query
description: Activity or plan definitions used by plan definition
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the plan definition
style: simple
- name: identifier
in: query
description: External identifier for the plan definition
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: The business version of the plan definition
style: simple
- name: url
in: query
description: The uri that identifies the plan definition
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: Computationally friendly name of the plan definition
style: simple
- name: publisher
in: query
description: Name of the publisher of the plan definition
style: simple
- name: topic
in: query
description: Topics associated with the module
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The current status of the plan definition
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PlanDefinition
summary: "create-type: Create a new PlanDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "PlanDefinition"
}
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'
/PlanDefinition/_history:
get:
tags:
- PlanDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type PlanDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PlanDefinition/{id}/_history:
get:
tags:
- PlanDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PlanDefinition"
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'
/PlanDefinition/$validate:
get:
tags:
- PlanDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PlanDefinition/{id}/$validate:
get:
tags:
- PlanDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PlanDefinition/{id}/$meta-delete:
post:
tags:
- PlanDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PlanDefinition/{id}/$meta-add:
post:
tags:
- PlanDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PlanDefinition/$meta:
get:
tags:
- PlanDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PlanDefinition/{id}/$meta:
get:
tags:
- PlanDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PlanDefinition/$expunge:
post:
tags:
- PlanDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PlanDefinition/{id}/$expunge:
post:
tags:
- PlanDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}:
get:
tags:
- Practitioner
summary: "read-instance: Read Practitioner instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Practitioner
summary: "update-instance: Update an existing Practitioner instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Practitioner"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Practitioner
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Practitioner
summary: "instance-patch: Patch a resource instance of type Practitioner by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/_history/{version_id}:
get:
tags:
- Practitioner
summary: "vread-instance: Read Practitioner instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner:
get:
tags:
- Practitioner
summary: "search-type: Search for Practitioner instances"
description: This is a search type
parameters:
- name: deceased
in: query
description: "This Practitioner has been marked as deceased, or has a death\
\ date entered"
style: simple
- name: address-state
in: query
description: "Multiple Resources: * [Patient](patient.html): A state specified\
\ in an address * [Person](person.html): A state specified in an address\
\ * [Practitioner](practitioner.html): A state specified in an address *\
\ [RelatedPerson](relatedperson.html): A state specified in an address "
style: simple
- name: gender
in: query
description: "Multiple Resources: * [Patient](patient.html): Gender of the\
\ patient * [Person](person.html): The gender of the person * [Practitioner](practitioner.html):\
\ Gender of the practitioner * [RelatedPerson](relatedperson.html): Gender\
\ of the related person "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: address-country
in: query
description: "Multiple Resources: * [Patient](patient.html): A country specified\
\ in an address * [Person](person.html): A country specified in an address\
\ * [Practitioner](practitioner.html): A country specified in an address\
\ * [RelatedPerson](relatedperson.html): A country specified in an address "
style: simple
- name: death-date
in: query
description: The date of death has been provided and satisfies this search
value
style: simple
- name: phonetic
in: query
description: "Multiple Resources: * [Patient](patient.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\
\ * [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm * [Practitioner](practitioner.html): A portion of either\
\ family or given name using some kind of phonetic matching algorithm *\
\ [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm "
style: simple
- name: telecom
in: query
description: "Multiple Resources: * [Patient](patient.html): The value in\
\ any kind of telecom details of the patient * [Person](person.html): The\
\ value in any kind of contact * [Practitioner](practitioner.html): The\
\ value in any kind of contact * [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact * [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact "
style: simple
- name: address-city
in: query
description: "Multiple Resources: * [Patient](patient.html): A city specified\
\ in an address * [Person](person.html): A city specified in an address\
\ * [Practitioner](practitioner.html): A city specified in an address *\
\ [RelatedPerson](relatedperson.html): A city specified in an address "
style: simple
- name: communication
in: query
description: One of the languages that the practitioner can communicate with
style: simple
- name: email
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ an email contact * [Person](person.html): A value in an email contact\
\ * [Practitioner](practitioner.html): A value in an email contact * [PractitionerRole](practitionerrole.html):\
\ A value in an email contact * [RelatedPerson](relatedperson.html): A value\
\ in an email contact "
style: simple
- name: given
in: query
description: "Multiple Resources: * [Patient](patient.html): A portion of\
\ the given name of the patient * [Practitioner](practitioner.html): A portion\
\ of the given name "
style: simple
- name: identifier
in: query
description: A practitioner's Identifier
style: simple
- name: address
in: query
description: "Multiple Resources: * [Patient](patient.html): A server defined\
\ search that may match any of the string fields in the Address, including\
\ line, city, district, state, country, postalCode, and/or text * [Person](person.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text * [Practitioner](practitioner.html): A server defined search that\
\ may match any of the string fields in the Address, including line, city,\
\ district, state, country, postalCode, and/or text * [RelatedPerson](relatedperson.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text "
style: simple
- name: qualification-period
in: query
description: The date(s) a qualification is valid for
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: Whether the practitioner record is active
style: simple
- name: address-postalcode
in: query
description: "Multiple Resources: * [Patient](patient.html): A postalCode\
\ specified in an address * [Person](person.html): A postal code specified\
\ in an address * [Practitioner](practitioner.html): A postalCode specified\
\ in an address * [RelatedPerson](relatedperson.html): A postal code specified\
\ in an address "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: phone
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ a phone contact * [Person](person.html): A value in a phone contact *\
\ [Practitioner](practitioner.html): A value in a phone contact * [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact * [RelatedPerson](relatedperson.html): A value\
\ in a phone contact "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: address-use
in: query
description: "Multiple Resources: * [Patient](patient.html): A use code\
\ specified in an address * [Person](person.html): A use code specified\
\ in an address * [Practitioner](practitioner.html): A use code specified\
\ in an address * [RelatedPerson](relatedperson.html): A use code specified\
\ in an address "
style: simple
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: family
in: query
description: "Multiple Resources: * [Patient](patient.html): A portion of\
\ the family name of the patient * [Practitioner](practitioner.html): A\
\ portion of the family name "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Practitioner
summary: "create-type: Create a new Practitioner instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Practitioner"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/_history:
get:
tags:
- Practitioner
summary: "type-history: Fetch the resource change history for all resources\
\ of type Practitioner"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/_history:
get:
tags:
- Practitioner
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Practitioner"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/$validate:
get:
tags:
- Practitioner
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$validate:
get:
tags:
- Practitioner
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$meta-delete:
post:
tags:
- Practitioner
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$meta-add:
post:
tags:
- Practitioner
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/$meta:
get:
tags:
- Practitioner
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$meta:
get:
tags:
- Practitioner
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/$expunge:
post:
tags:
- Practitioner
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Practitioner/{id}/$expunge:
post:
tags:
- Practitioner
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}:
get:
tags:
- PractitionerRole
summary: "read-instance: Read PractitionerRole instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- PractitionerRole
summary: "update-instance: Update an existing PractitionerRole instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "PractitionerRole"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- PractitionerRole
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- PractitionerRole
summary: "instance-patch: Patch a resource instance of type PractitionerRole\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/_history/{version_id}:
get:
tags:
- PractitionerRole
summary: "vread-instance: Read PractitionerRole instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole:
get:
tags:
- PractitionerRole
summary: "search-type: Search for PractitionerRole instances"
description: This is a search type
parameters:
- name: date
in: query
description: The period during which the practitioner is authorized to perform
in these role(s)
style: simple
- name: identifier
in: query
description: A practitioner's Identifier
style: simple
- name: specialty
in: query
description: The practitioner has this specialty at an organization
style: simple
- name: role
in: query
description: The practitioner can perform this role at for the organization
style: simple
- name: practitioner
in: query
description: Practitioner that is able to provide the defined services for
the organization
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: Whether this practitioner role record is in active use
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the practitioner with this role
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: phone
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ a phone contact * [Person](person.html): A value in a phone contact *\
\ [Practitioner](practitioner.html): A value in a phone contact * [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact * [RelatedPerson](relatedperson.html): A value\
\ in a phone contact "
style: simple
- name: service
in: query
description: The list of healthcare services that this worker provides for
this role's Organization/Location(s)
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: organization
in: query
description: The identity of the organization the practitioner represents
/ acts on behalf of
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: telecom
in: query
description: "Multiple Resources: * [Patient](patient.html): The value in\
\ any kind of telecom details of the patient * [Person](person.html): The\
\ value in any kind of contact * [Practitioner](practitioner.html): The\
\ value in any kind of contact * [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact * [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact "
style: simple
- name: location
in: query
description: One of the locations at which this practitioner provides care
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: email
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ an email contact * [Person](person.html): A value in an email contact\
\ * [Practitioner](practitioner.html): A value in an email contact * [PractitionerRole](practitionerrole.html):\
\ A value in an email contact * [RelatedPerson](relatedperson.html): A value\
\ in an email contact "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- PractitionerRole
summary: "create-type: Create a new PractitionerRole instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "PractitionerRole"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/_history:
get:
tags:
- PractitionerRole
summary: "type-history: Fetch the resource change history for all resources\
\ of type PractitionerRole"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/_history:
get:
tags:
- PractitionerRole
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PractitionerRole"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/$validate:
get:
tags:
- PractitionerRole
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$validate:
get:
tags:
- PractitionerRole
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$meta-delete:
post:
tags:
- PractitionerRole
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$meta-add:
post:
tags:
- PractitionerRole
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/$meta:
get:
tags:
- PractitionerRole
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$meta:
get:
tags:
- PractitionerRole
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/$expunge:
post:
tags:
- PractitionerRole
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/PractitionerRole/{id}/$expunge:
post:
tags:
- PractitionerRole
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/{id}:
get:
tags:
- Procedure
summary: "read-instance: Read Procedure instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Procedure
summary: "update-instance: Update an existing Procedure instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Procedure"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- Procedure
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- Procedure
summary: "instance-patch: Patch a resource instance of type Procedure by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/{id}/_history/{version_id}:
get:
tags:
- Procedure
summary: "vread-instance: Read Procedure instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure:
get:
tags:
- Procedure
summary: "search-type: Search for Procedure instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: subject
in: query
description: Search by subject
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: part-of
in: query
description: Part of referenced event
style: simple
- name: reason-code
in: query
description: Reference to a concept (by class)
style: simple
- name: based-on
in: query
description: A request for this procedure
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: performer
in: query
description: Who performed the procedure
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [Composition](composition.html): Context\
\ of the Composition * [DeviceRequest](devicerequest.html): Encounter during\
\ which request was created * [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made * [Flag](flag.html): Alert relevant\
\ during encounter * [List](list.html): Context in which list created *\
\ [NutritionOrder](nutritionorder.html): Return nutrition orders with this\
\ encounter identifier * [Observation](observation.html): Encounter related\
\ to the observation * [Procedure](procedure.html): The Encounter during\
\ which this Procedure was created * [RiskAssessment](riskassessment.html):\
\ Where was assessment performed? * [ServiceRequest](servicerequest.html):\
\ An encounter in which this request is made * [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: reason-reference
in: query
description: Reference to a resource (by instance)
style: simple
- name: report
in: query
description: Any report resulting from the procedure
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: Where the procedure happened
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: Classification of the procedure
style: simple
- name: status
in: query
description: preparation | in-progress | not-done | on-hold | stopped | completed
| entered-in-error | unknown
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Procedure
summary: "create-type: Create a new Procedure instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Procedure"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/_history:
get:
tags:
- Procedure
summary: "type-history: Fetch the resource change history for all resources\
\ of type Procedure"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/{id}/_history:
get:
tags:
- Procedure
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Procedure"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/$validate:
get:
tags:
- Procedure
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/{id}/$validate:
get:
tags:
- Procedure
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/{id}/$meta-delete:
post:
tags:
- Procedure
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/{id}/$meta-add:
post:
tags:
- Procedure
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/$meta:
get:
tags:
- Procedure
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/{id}/$meta:
get:
tags:
- Procedure
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/$expunge:
post:
tags:
- Procedure
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Procedure/{id}/$expunge:
post:
tags:
- Procedure
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Provenance/{id}:
get:
tags:
- Provenance
summary: "read-instance: Read Provenance instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- Provenance
summary: "update-instance: Update an existing Provenance 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": "Provenance"
}
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:
- Provenance
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:
- Provenance
summary: "instance-patch: Patch a resource instance of type Provenance 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'
/Provenance/{id}/_history/{version_id}:
get:
tags:
- Provenance
summary: "vread-instance: Read Provenance 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'
/Provenance:
get:
tags:
- Provenance
summary: "search-type: Search for Provenance instances"
description: This is a search type
parameters:
- name: agent-type
in: query
description: How the agent participated
style: simple
- name: agent
in: query
description: Who participated
style: simple
- name: signature-type
in: query
description: Indication of the reason the entity signed the object(s)
style: simple
- name: activity
in: query
description: Activity that occurred
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: Encounter related to the Provenance
style: simple
- name: recorded
in: query
description: When the activity was recorded / updated
style: simple
- name: when
in: query
description: When the activity occurred
style: simple
- name: target
in: query
description: Target Reference(s) (usually version specific)
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: based-on
in: query
description: Reference to the service request.
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: Where the activity involved patient data
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: "Where the activity occurred, if relevant"
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: agent-role
in: query
description: What the agents role was
style: simple
- name: entity
in: query
description: Identity of entity
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Provenance
summary: "create-type: Create a new Provenance instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Provenance"
}
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'
/Provenance/_history:
get:
tags:
- Provenance
summary: "type-history: Fetch the resource change history for all resources\
\ of type Provenance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Provenance/{id}/_history:
get:
tags:
- Provenance
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Provenance"
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'
/Provenance/$validate:
get:
tags:
- Provenance
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Provenance/{id}/$validate:
get:
tags:
- Provenance
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Provenance/{id}/$meta-delete:
post:
tags:
- Provenance
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Provenance/{id}/$meta-add:
post:
tags:
- Provenance
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Provenance/$meta:
get:
tags:
- Provenance
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Provenance/{id}/$meta:
get:
tags:
- Provenance
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Provenance/$expunge:
post:
tags:
- Provenance
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Provenance/{id}/$expunge:
post:
tags:
- Provenance
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Questionnaire/{id}:
get:
tags:
- Questionnaire
summary: "read-instance: Read Questionnaire 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:
- Questionnaire
summary: "update-instance: Update an existing Questionnaire 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": "Questionnaire"
}
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:
- Questionnaire
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:
- Questionnaire
summary: "instance-patch: Patch a resource instance of type Questionnaire 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'
/Questionnaire/{id}/_history/{version_id}:
get:
tags:
- Questionnaire
summary: "vread-instance: Read Questionnaire 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'
/Questionnaire:
get:
tags:
- Questionnaire
summary: "search-type: Search for Questionnaire instances"
description: This is a search type
parameters:
- name: date
in: query
description: The questionnaire publication date
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the questionnaire
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: Intended jurisdiction for the questionnaire
style: simple
- name: description
in: query
description: The description of the questionnaire
style: simple
- name: context-type
in: query
description: A type of use context assigned to the questionnaire
style: simple
- name: title
in: query
description: The human-friendly name of the questionnaire
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the questionnaire
style: simple
- name: effective
in: query
description: The time during which the questionnaire is intended to be in
use
style: simple
- name: context
in: query
description: A use context assigned to the questionnaire
style: simple
- name: definition
in: query
description: ElementDefinition - details for the item
style: simple
- name: questionnaire-code
in: query
description: A code that matches one of the Questionnaire.code codings
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the questionnaire
style: simple
- name: identifier
in: query
description: External identifier for the questionnaire
style: simple
- name: combo-code
in: query
description: A code that corresponds to one of its items in the questionnaire
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: The business version of the questionnaire
style: simple
- name: url
in: query
description: The uri that identifies the questionnaire
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: subject-type
in: query
description: Resource that can be subject of QuestionnaireResponse
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: Computationally friendly name of the questionnaire
style: simple
- name: publisher
in: query
description: Name of the publisher of the questionnaire
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: item-code
in: query
description: A code that corresponds to one of the items in the questionnaire
style: simple
- name: status
in: query
description: The current status of the questionnaire
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Questionnaire
summary: "create-type: Create a new Questionnaire instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Questionnaire"
}
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'
/Questionnaire/_history:
get:
tags:
- Questionnaire
summary: "type-history: Fetch the resource change history for all resources\
\ of type Questionnaire"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Questionnaire/{id}/_history:
get:
tags:
- Questionnaire
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Questionnaire"
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'
/Questionnaire/$validate:
get:
tags:
- Questionnaire
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Questionnaire/{id}/$validate:
get:
tags:
- Questionnaire
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Questionnaire/{id}/$meta-delete:
post:
tags:
- Questionnaire
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Questionnaire/{id}/$meta-add:
post:
tags:
- Questionnaire
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Questionnaire/$meta:
get:
tags:
- Questionnaire
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Questionnaire/{id}/$meta:
get:
tags:
- Questionnaire
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Questionnaire/$expunge:
post:
tags:
- Questionnaire
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Questionnaire/{id}/$expunge:
post:
tags:
- Questionnaire
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/QuestionnaireResponse/{id}:
get:
tags:
- QuestionnaireResponse
summary: "read-instance: Read QuestionnaireResponse 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:
- QuestionnaireResponse
summary: "update-instance: Update an existing QuestionnaireResponse 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": "QuestionnaireResponse"
}
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:
- QuestionnaireResponse
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:
- QuestionnaireResponse
summary: "instance-patch: Patch a resource instance of type QuestionnaireResponse\
\ 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'
/QuestionnaireResponse/{id}/_history/{version_id}:
get:
tags:
- QuestionnaireResponse
summary: "vread-instance: Read QuestionnaireResponse 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'
/QuestionnaireResponse:
get:
tags:
- QuestionnaireResponse
summary: "search-type: Search for QuestionnaireResponse instances"
description: This is a search type
parameters:
- name: authored
in: query
description: When the questionnaire response was last changed
style: simple
- name: identifier
in: query
description: The unique identifier for the questionnaire response
style: simple
- name: questionnaire
in: query
description: The questionnaire the answers are provided for
style: simple
- name: author
in: query
description: The author of the questionnaire response
style: simple
- name: subject
in: query
description: The subject of the questionnaire response
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: part-of
in: query
description: Procedure or observation this questionnaire response was performed
as a part of
style: simple
- name: encounter
in: query
description: Encounter associated with the questionnaire response
style: simple
- name: item-subject
in: query
description: Allows searching for QuestionnaireResponses by item value where
the item has isSubject=true
style: simple
- name: source
in: query
description: The individual providing the information reflected in the questionnaire
respose
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: based-on
in: query
description: Plan/proposal/order fulfilled by this questionnaire response
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: The patient that is the subject of the questionnaire response
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of the questionnaire response
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- QuestionnaireResponse
summary: "create-type: Create a new QuestionnaireResponse instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "QuestionnaireResponse"
}
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'
/QuestionnaireResponse/_history:
get:
tags:
- QuestionnaireResponse
summary: "type-history: Fetch the resource change history for all resources\
\ of type QuestionnaireResponse"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/QuestionnaireResponse/{id}/_history:
get:
tags:
- QuestionnaireResponse
summary: "instance-history: Fetch the resource change history for all resources\
\ of type QuestionnaireResponse"
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'
/QuestionnaireResponse/$validate:
get:
tags:
- QuestionnaireResponse
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/QuestionnaireResponse/{id}/$validate:
get:
tags:
- QuestionnaireResponse
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/QuestionnaireResponse/{id}/$meta-delete:
post:
tags:
- QuestionnaireResponse
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/QuestionnaireResponse/{id}/$meta-add:
post:
tags:
- QuestionnaireResponse
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/QuestionnaireResponse/$meta:
get:
tags:
- QuestionnaireResponse
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/QuestionnaireResponse/{id}/$meta:
get:
tags:
- QuestionnaireResponse
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/QuestionnaireResponse/$expunge:
post:
tags:
- QuestionnaireResponse
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/QuestionnaireResponse/{id}/$expunge:
post:
tags:
- QuestionnaireResponse
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RegulatedAuthorization/{id}:
get:
tags:
- RegulatedAuthorization
summary: "read-instance: Read RegulatedAuthorization 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:
- RegulatedAuthorization
summary: "update-instance: Update an existing RegulatedAuthorization 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": "RegulatedAuthorization"
}
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:
- RegulatedAuthorization
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:
- RegulatedAuthorization
summary: "instance-patch: Patch a resource instance of type RegulatedAuthorization\
\ 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'
/RegulatedAuthorization/{id}/_history/{version_id}:
get:
tags:
- RegulatedAuthorization
summary: "vread-instance: Read RegulatedAuthorization 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'
/RegulatedAuthorization:
get:
tags:
- RegulatedAuthorization
summary: "search-type: Search for RegulatedAuthorization instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Business identifier for the authorization, typically assigned\
\ by the authorizing body"
style: simple
- name: subject
in: query
description: "The type of regulated product, treatment, facility or activity\
\ that is being authorized"
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: case-type
in: query
description: The defining type of case
style: simple
- name: holder
in: query
description: The organization that holds the granted authorization
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: region
in: query
description: "The territory (e.g., country, jurisdiction etc.) in which the\
\ authorization has been granted"
style: simple
- name: case
in: query
description: The case or procedure number
style: simple
- name: status
in: query
description: The status that is authorised e.g. approved. Intermediate states
can be tracked with cases and applications
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- RegulatedAuthorization
summary: "create-type: Create a new RegulatedAuthorization instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "RegulatedAuthorization"
}
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'
/RegulatedAuthorization/_history:
get:
tags:
- RegulatedAuthorization
summary: "type-history: Fetch the resource change history for all resources\
\ of type RegulatedAuthorization"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RegulatedAuthorization/{id}/_history:
get:
tags:
- RegulatedAuthorization
summary: "instance-history: Fetch the resource change history for all resources\
\ of type RegulatedAuthorization"
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'
/RegulatedAuthorization/$validate:
get:
tags:
- RegulatedAuthorization
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RegulatedAuthorization/{id}/$validate:
get:
tags:
- RegulatedAuthorization
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RegulatedAuthorization/{id}/$meta-delete:
post:
tags:
- RegulatedAuthorization
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RegulatedAuthorization/{id}/$meta-add:
post:
tags:
- RegulatedAuthorization
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RegulatedAuthorization/$meta:
get:
tags:
- RegulatedAuthorization
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RegulatedAuthorization/{id}/$meta:
get:
tags:
- RegulatedAuthorization
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RegulatedAuthorization/$expunge:
post:
tags:
- RegulatedAuthorization
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RegulatedAuthorization/{id}/$expunge:
post:
tags:
- RegulatedAuthorization
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RelatedPerson/{id}:
get:
tags:
- RelatedPerson
summary: "read-instance: Read RelatedPerson 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:
- RelatedPerson
summary: "update-instance: Update an existing RelatedPerson 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": "RelatedPerson"
}
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:
- RelatedPerson
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:
- RelatedPerson
summary: "instance-patch: Patch a resource instance of type RelatedPerson 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'
/RelatedPerson/{id}/_history/{version_id}:
get:
tags:
- RelatedPerson
summary: "vread-instance: Read RelatedPerson 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'
/RelatedPerson:
get:
tags:
- RelatedPerson
summary: "search-type: Search for RelatedPerson instances"
description: This is a search type
parameters:
- name: birthdate
in: query
description: "Multiple Resources: * [Patient](patient.html): The patient's\
\ date of birth * [Person](person.html): The person's date of birth * [RelatedPerson](relatedperson.html):\
\ The Related Person's date of birth "
style: simple
- name: address-state
in: query
description: "Multiple Resources: * [Patient](patient.html): A state specified\
\ in an address * [Person](person.html): A state specified in an address\
\ * [Practitioner](practitioner.html): A state specified in an address *\
\ [RelatedPerson](relatedperson.html): A state specified in an address "
style: simple
- name: gender
in: query
description: "Multiple Resources: * [Patient](patient.html): Gender of the\
\ patient * [Person](person.html): The gender of the person * [Practitioner](practitioner.html):\
\ Gender of the practitioner * [RelatedPerson](relatedperson.html): Gender\
\ of the related person "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: address-country
in: query
description: "Multiple Resources: * [Patient](patient.html): A country specified\
\ in an address * [Person](person.html): A country specified in an address\
\ * [Practitioner](practitioner.html): A country specified in an address\
\ * [RelatedPerson](relatedperson.html): A country specified in an address "
style: simple
- name: phonetic
in: query
description: "Multiple Resources: * [Patient](patient.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\
\ * [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm * [Practitioner](practitioner.html): A portion of either\
\ family or given name using some kind of phonetic matching algorithm *\
\ [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm "
style: simple
- name: patient
in: query
description: The patient this related person is related to
style: simple
- name: telecom
in: query
description: "Multiple Resources: * [Patient](patient.html): The value in\
\ any kind of telecom details of the patient * [Person](person.html): The\
\ value in any kind of contact * [Practitioner](practitioner.html): The\
\ value in any kind of contact * [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact * [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact "
style: simple
- name: address-city
in: query
description: "Multiple Resources: * [Patient](patient.html): A city specified\
\ in an address * [Person](person.html): A city specified in an address\
\ * [Practitioner](practitioner.html): A city specified in an address *\
\ [RelatedPerson](relatedperson.html): A city specified in an address "
style: simple
- name: relationship
in: query
description: The relationship between the patient and the relatedperson
style: simple
- name: email
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ an email contact * [Person](person.html): A value in an email contact\
\ * [Practitioner](practitioner.html): A value in an email contact * [PractitionerRole](practitionerrole.html):\
\ A value in an email contact * [RelatedPerson](relatedperson.html): A value\
\ in an email contact "
style: simple
- name: given
in: query
description: A portion of the given name of the related person
style: simple
- name: identifier
in: query
description: An Identifier of the RelatedPerson
style: simple
- name: address
in: query
description: "Multiple Resources: * [Patient](patient.html): A server defined\
\ search that may match any of the string fields in the Address, including\
\ line, city, district, state, country, postalCode, and/or text * [Person](person.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text * [Practitioner](practitioner.html): A server defined search that\
\ may match any of the string fields in the Address, including line, city,\
\ district, state, country, postalCode, and/or text * [RelatedPerson](relatedperson.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text "
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: Indicates if the related person record is active
style: simple
- name: address-postalcode
in: query
description: "Multiple Resources: * [Patient](patient.html): A postalCode\
\ specified in an address * [Person](person.html): A postal code specified\
\ in an address * [Practitioner](practitioner.html): A postalCode specified\
\ in an address * [RelatedPerson](relatedperson.html): A postal code specified\
\ in an address "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: phone
in: query
description: "Multiple Resources: * [Patient](patient.html): A value in\
\ a phone contact * [Person](person.html): A value in a phone contact *\
\ [Practitioner](practitioner.html): A value in a phone contact * [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact * [RelatedPerson](relatedperson.html): A value\
\ in a phone contact "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: address-use
in: query
description: "Multiple Resources: * [Patient](patient.html): A use code\
\ specified in an address * [Person](person.html): A use code specified\
\ in an address * [Practitioner](practitioner.html): A use code specified\
\ in an address * [RelatedPerson](relatedperson.html): A use code specified\
\ in an address "
style: simple
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: family
in: query
description: A portion of the family name of the related person
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- RelatedPerson
summary: "create-type: Create a new RelatedPerson instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "RelatedPerson"
}
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'
/RelatedPerson/_history:
get:
tags:
- RelatedPerson
summary: "type-history: Fetch the resource change history for all resources\
\ of type RelatedPerson"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RelatedPerson/{id}/_history:
get:
tags:
- RelatedPerson
summary: "instance-history: Fetch the resource change history for all resources\
\ of type RelatedPerson"
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'
/RelatedPerson/$validate:
get:
tags:
- RelatedPerson
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RelatedPerson/{id}/$validate:
get:
tags:
- RelatedPerson
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RelatedPerson/{id}/$meta-delete:
post:
tags:
- RelatedPerson
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RelatedPerson/{id}/$meta-add:
post:
tags:
- RelatedPerson
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RelatedPerson/$meta:
get:
tags:
- RelatedPerson
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RelatedPerson/{id}/$meta:
get:
tags:
- RelatedPerson
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RelatedPerson/$expunge:
post:
tags:
- RelatedPerson
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RelatedPerson/{id}/$expunge:
post:
tags:
- RelatedPerson
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestGroup/{id}:
get:
tags:
- RequestGroup
summary: "read-instance: Read RequestGroup 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:
- RequestGroup
summary: "update-instance: Update an existing RequestGroup 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": "RequestGroup"
}
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:
- RequestGroup
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:
- RequestGroup
summary: "instance-patch: Patch a resource instance of type RequestGroup 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'
/RequestGroup/{id}/_history/{version_id}:
get:
tags:
- RequestGroup
summary: "vread-instance: Read RequestGroup 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'
/RequestGroup:
get:
tags:
- RequestGroup
summary: "search-type: Search for RequestGroup instances"
description: This is a search type
parameters:
- name: authored
in: query
description: The date the request group was authored
style: simple
- name: identifier
in: query
description: External identifiers for the request group
style: simple
- name: code
in: query
description: The code of the request group
style: simple
- name: author
in: query
description: The author of the request group
style: simple
- name: subject
in: query
description: The subject that the request group is about
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: instantiates-canonical
in: query
description: The FHIR-based definition from which the request group is realized
style: simple
- name: encounter
in: query
description: The encounter the request group applies to
style: simple
- name: priority
in: query
description: The priority of the request group
style: simple
- name: intent
in: query
description: The intent of the request group
style: simple
- name: participant
in: query
description: The participant in the requests in the group
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: group-identifier
in: query
description: The group identifier for the request group
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: The identity of a patient to search for request groups
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: instantiates-uri
in: query
description: The external definition from which the request group is realized
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of the request group
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- RequestGroup
summary: "create-type: Create a new RequestGroup instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "RequestGroup"
}
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'
/RequestGroup/_history:
get:
tags:
- RequestGroup
summary: "type-history: Fetch the resource change history for all resources\
\ of type RequestGroup"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestGroup/{id}/_history:
get:
tags:
- RequestGroup
summary: "instance-history: Fetch the resource change history for all resources\
\ of type RequestGroup"
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'
/RequestGroup/$validate:
get:
tags:
- RequestGroup
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestGroup/{id}/$validate:
get:
tags:
- RequestGroup
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestGroup/{id}/$meta-delete:
post:
tags:
- RequestGroup
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestGroup/{id}/$meta-add:
post:
tags:
- RequestGroup
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestGroup/$meta:
get:
tags:
- RequestGroup
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestGroup/{id}/$meta:
get:
tags:
- RequestGroup
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestGroup/$expunge:
post:
tags:
- RequestGroup
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestGroup/{id}/$expunge:
post:
tags:
- RequestGroup
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestOrchestration/{id}:
get:
tags:
- RequestOrchestration
summary: "read-instance: Read RequestOrchestration 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:
- RequestOrchestration
summary: "update-instance: Update an existing RequestOrchestration 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": "RequestOrchestration"
}
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:
- RequestOrchestration
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:
- RequestOrchestration
summary: "instance-patch: Patch a resource instance of type RequestOrchestration\
\ 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'
/RequestOrchestration/{id}/_history/{version_id}:
get:
tags:
- RequestOrchestration
summary: "vread-instance: Read RequestOrchestration 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'
/RequestOrchestration:
get:
tags:
- RequestOrchestration
summary: "search-type: Search for RequestOrchestration instances"
description: This is a search type
parameters:
- name: authored
in: query
description: The date the request orchestration was authored
style: simple
- name: identifier
in: query
description: External identifiers for the request orchestration
style: simple
- name: code
in: query
description: The code of the request orchestration
style: simple
- name: author
in: query
description: The author of the request orchestration
style: simple
- name: subject
in: query
description: The subject that the request orchestration is about
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: instantiates-canonical
in: query
description: The FHIR-based definition from which the request orchestration
is realized
style: simple
- name: encounter
in: query
description: The encounter the request orchestration applies to
style: simple
- name: priority
in: query
description: The priority of the request orchestration
style: simple
- name: intent
in: query
description: The intent of the request orchestration
style: simple
- name: participant
in: query
description: The participant in the requests in the orchestration
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: group-identifier
in: query
description: The group identifier for the request orchestration
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: The identity of a patient to search for request orchestrations
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: instantiates-uri
in: query
description: The external definition from which the request orchestration
is realized
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of the request orchestration
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- RequestOrchestration
summary: "create-type: Create a new RequestOrchestration instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "RequestOrchestration"
}
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'
/RequestOrchestration/_history:
get:
tags:
- RequestOrchestration
summary: "type-history: Fetch the resource change history for all resources\
\ of type RequestOrchestration"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestOrchestration/{id}/_history:
get:
tags:
- RequestOrchestration
summary: "instance-history: Fetch the resource change history for all resources\
\ of type RequestOrchestration"
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'
/RequestOrchestration/$validate:
get:
tags:
- RequestOrchestration
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestOrchestration/{id}/$validate:
get:
tags:
- RequestOrchestration
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestOrchestration/{id}/$meta-delete:
post:
tags:
- RequestOrchestration
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestOrchestration/{id}/$meta-add:
post:
tags:
- RequestOrchestration
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestOrchestration/$meta:
get:
tags:
- RequestOrchestration
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestOrchestration/{id}/$meta:
get:
tags:
- RequestOrchestration
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestOrchestration/$expunge:
post:
tags:
- RequestOrchestration
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RequestOrchestration/{id}/$expunge:
post:
tags:
- RequestOrchestration
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Requirements/{id}:
get:
tags:
- Requirements
summary: "read-instance: Read Requirements 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:
- Requirements
summary: "update-instance: Update an existing Requirements 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": "Requirements"
}
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:
- Requirements
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:
- Requirements
summary: "instance-patch: Patch a resource instance of type Requirements 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'
/Requirements/{id}/_history/{version_id}:
get:
tags:
- Requirements
summary: "vread-instance: Read Requirements 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'
/Requirements:
get:
tags:
- Requirements
summary: "search-type: Search for Requirements instances"
description: This is a search type
parameters:
- name: date
in: query
description: The requirements publication date
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the requirements
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: Intended jurisdiction for the requirements
style: simple
- name: derived-from
in: query
description: The requirements these are derived from
style: simple
- name: description
in: query
description: The description of the requirements
style: simple
- name: context-type
in: query
description: A type of use context assigned to the requirements
style: simple
- name: title
in: query
description: The human-friendly name of the requirements
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the requirements
style: simple
- name: context
in: query
description: A use context assigned to the requirements
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the requirements
style: simple
- name: identifier
in: query
description: External identifier for the requirements
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: The business version of the requirements
style: simple
- name: url
in: query
description: The uri that identifies the requirements
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: actor
in: query
description: An actor these requirements are for
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: Computationally friendly name of the requirements
style: simple
- name: publisher
in: query
description: Name of the publisher of the requirements
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The current status of the requirements
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Requirements
summary: "create-type: Create a new Requirements instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Requirements"
}
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'
/Requirements/_history:
get:
tags:
- Requirements
summary: "type-history: Fetch the resource change history for all resources\
\ of type Requirements"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Requirements/{id}/_history:
get:
tags:
- Requirements
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Requirements"
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'
/Requirements/$validate:
get:
tags:
- Requirements
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Requirements/{id}/$validate:
get:
tags:
- Requirements
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Requirements/{id}/$meta-delete:
post:
tags:
- Requirements
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Requirements/{id}/$meta-add:
post:
tags:
- Requirements
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Requirements/$meta:
get:
tags:
- Requirements
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Requirements/{id}/$meta:
get:
tags:
- Requirements
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Requirements/$expunge:
post:
tags:
- Requirements
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Requirements/{id}/$expunge:
post:
tags:
- Requirements
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchStudy/{id}:
get:
tags:
- ResearchStudy
summary: "read-instance: Read ResearchStudy 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:
- ResearchStudy
summary: "update-instance: Update an existing ResearchStudy 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": "ResearchStudy"
}
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:
- ResearchStudy
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:
- ResearchStudy
summary: "instance-patch: Patch a resource instance of type ResearchStudy 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'
/ResearchStudy/{id}/_history/{version_id}:
get:
tags:
- ResearchStudy
summary: "vread-instance: Read ResearchStudy 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'
/ResearchStudy:
get:
tags:
- ResearchStudy
summary: "search-type: Search for ResearchStudy instances"
description: This is a search type
parameters:
- name: date
in: query
description: When the study began and ended
style: simple
- name: sponsor
in: query
description: Organization that initiates and is legally responsible for the
study
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: focus
in: query
description: "Drugs, devices, etc. under study"
style: simple
- name: principalinvestigator
in: query
description: Researcher who oversees multiple aspects of the study
style: simple
- name: title
in: query
description: Name for this study
style: simple
- name: recruitment_actual
in: query
description: Actual number of participants enrolled in study across all groups
style: simple
- name: protocol
in: query
description: Steps followed in executing study
style: simple
- name: keyword
in: query
description: Used to search for the study
style: simple
- name: identifier
in: query
description: Business Identifier for study
style: simple
- name: partof
in: query
description: Part of larger study
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: condition
in: query
description: Condition being studied
style: simple
- name: site
in: query
description: Facility where study activities are conducted
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: Geographic region(s) for study
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: Classifications for the study
style: simple
- name: region
in: query
description: Geographic area for the study
style: simple
- name: recruitment_target
in: query
description: Target number of participants enrolled in study across all groups
style: simple
- name: status
in: query
description: active | active-but-not-recruiting | administratively-completed
| approved | closed-to-accrual | closed-to-accrual-and-intervention | completed
| disapproved | enrolling-by-invitation | in-review | not-yet-recruiting
| recruiting | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention
| terminated | withdrawn
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ResearchStudy
summary: "create-type: Create a new ResearchStudy instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ResearchStudy"
}
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'
/ResearchStudy/_history:
get:
tags:
- ResearchStudy
summary: "type-history: Fetch the resource change history for all resources\
\ of type ResearchStudy"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchStudy/{id}/_history:
get:
tags:
- ResearchStudy
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ResearchStudy"
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'
/ResearchStudy/$validate:
get:
tags:
- ResearchStudy
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchStudy/{id}/$validate:
get:
tags:
- ResearchStudy
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchStudy/{id}/$meta-delete:
post:
tags:
- ResearchStudy
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchStudy/{id}/$meta-add:
post:
tags:
- ResearchStudy
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchStudy/$meta:
get:
tags:
- ResearchStudy
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchStudy/{id}/$meta:
get:
tags:
- ResearchStudy
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchStudy/$expunge:
post:
tags:
- ResearchStudy
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchStudy/{id}/$expunge:
post:
tags:
- ResearchStudy
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchSubject/{id}:
get:
tags:
- ResearchSubject
summary: "read-instance: Read ResearchSubject 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:
- ResearchSubject
summary: "update-instance: Update an existing ResearchSubject 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": "ResearchSubject"
}
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:
- ResearchSubject
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:
- ResearchSubject
summary: "instance-patch: Patch a resource instance of type ResearchSubject\
\ 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'
/ResearchSubject/{id}/_history/{version_id}:
get:
tags:
- ResearchSubject
summary: "vread-instance: Read ResearchSubject 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'
/ResearchSubject:
get:
tags:
- ResearchSubject
summary: "search-type: Search for ResearchSubject instances"
description: This is a search type
parameters:
- name: date
in: query
description: Start and end of participation
style: simple
- name: identifier
in: query
description: Business Identifier for research subject in a study
style: simple
- name: study
in: query
description: Study subject is part of
style: simple
- name: subject
in: query
description: Who or what is part of study
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: subject_state
in: query
description: candidate | eligible | follow-up | ineligible | not-registered
| off-study | on-study | on-study-intervention | on-study-observation |
pending-on-study | potential-candidate | screening | withdrawn
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: Who or what is part of study
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: draft | active | retired | unknown
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ResearchSubject
summary: "create-type: Create a new ResearchSubject instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ResearchSubject"
}
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'
/ResearchSubject/_history:
get:
tags:
- ResearchSubject
summary: "type-history: Fetch the resource change history for all resources\
\ of type ResearchSubject"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchSubject/{id}/_history:
get:
tags:
- ResearchSubject
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ResearchSubject"
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'
/ResearchSubject/$validate:
get:
tags:
- ResearchSubject
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchSubject/{id}/$validate:
get:
tags:
- ResearchSubject
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchSubject/{id}/$meta-delete:
post:
tags:
- ResearchSubject
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchSubject/{id}/$meta-add:
post:
tags:
- ResearchSubject
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchSubject/$meta:
get:
tags:
- ResearchSubject
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchSubject/{id}/$meta:
get:
tags:
- ResearchSubject
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchSubject/$expunge:
post:
tags:
- ResearchSubject
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ResearchSubject/{id}/$expunge:
post:
tags:
- ResearchSubject
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RiskAssessment/{id}:
get:
tags:
- RiskAssessment
summary: "read-instance: Read RiskAssessment 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:
- RiskAssessment
summary: "update-instance: Update an existing RiskAssessment 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": "RiskAssessment"
}
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:
- RiskAssessment
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:
- RiskAssessment
summary: "instance-patch: Patch a resource instance of type RiskAssessment 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'
/RiskAssessment/{id}/_history/{version_id}:
get:
tags:
- RiskAssessment
summary: "vread-instance: Read RiskAssessment 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'
/RiskAssessment:
get:
tags:
- RiskAssessment
summary: "search-type: Search for RiskAssessment instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: performer
in: query
description: Who did assessment?
style: simple
- name: method
in: query
description: Evaluation mechanism
style: simple
- name: probability
in: query
description: Likelihood of specified outcome
style: simple
- name: subject
in: query
description: Who/what does assessment apply to?
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [Composition](composition.html): Context\
\ of the Composition * [DeviceRequest](devicerequest.html): Encounter during\
\ which request was created * [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made * [Flag](flag.html): Alert relevant\
\ during encounter * [List](list.html): Context in which list created *\
\ [NutritionOrder](nutritionorder.html): Return nutrition orders with this\
\ encounter identifier * [Observation](observation.html): Encounter related\
\ to the observation * [Procedure](procedure.html): The Encounter during\
\ which this Procedure was created * [RiskAssessment](riskassessment.html):\
\ Where was assessment performed? * [ServiceRequest](servicerequest.html):\
\ An encounter in which this request is made * [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: condition
in: query
description: Condition assessed
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: risk
in: query
description: Likelihood of specified outcome as a qualitative value
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- RiskAssessment
summary: "create-type: Create a new RiskAssessment instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "RiskAssessment"
}
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'
/RiskAssessment/_history:
get:
tags:
- RiskAssessment
summary: "type-history: Fetch the resource change history for all resources\
\ of type RiskAssessment"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RiskAssessment/{id}/_history:
get:
tags:
- RiskAssessment
summary: "instance-history: Fetch the resource change history for all resources\
\ of type RiskAssessment"
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'
/RiskAssessment/$validate:
get:
tags:
- RiskAssessment
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RiskAssessment/{id}/$validate:
get:
tags:
- RiskAssessment
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RiskAssessment/{id}/$meta-delete:
post:
tags:
- RiskAssessment
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RiskAssessment/{id}/$meta-add:
post:
tags:
- RiskAssessment
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RiskAssessment/$meta:
get:
tags:
- RiskAssessment
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RiskAssessment/{id}/$meta:
get:
tags:
- RiskAssessment
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RiskAssessment/$expunge:
post:
tags:
- RiskAssessment
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/RiskAssessment/{id}/$expunge:
post:
tags:
- RiskAssessment
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Schedule/{id}:
get:
tags:
- Schedule
summary: "read-instance: Read Schedule 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:
- Schedule
summary: "update-instance: Update an existing Schedule 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": "Schedule"
}
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:
- Schedule
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:
- Schedule
summary: "instance-patch: Patch a resource instance of type Schedule 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'
/Schedule/{id}/_history/{version_id}:
get:
tags:
- Schedule
summary: "vread-instance: Read Schedule 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'
/Schedule:
get:
tags:
- Schedule
summary: "search-type: Search for Schedule instances"
description: This is a search type
parameters:
- name: date
in: query
description: Search for Schedule resources that have a period that contains
this date specified
style: simple
- name: identifier
in: query
description: A Schedule Identifier
style: simple
- name: specialty
in: query
description: Type of specialty needed
style: simple
- name: service-category
in: query
description: High-level category
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: service-type
in: query
description: The type (by coding) of appointments that can be booked into
associated slot(s)
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: Is the schedule in active use
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: actor
in: query
description: "The individual(HealthcareService, Practitioner, Location, ...)\
\ to find a Schedule for"
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: A portion of the Schedule name
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: service-type-reference
in: query
description: The type (by HealthcareService) of appointments that can be booked
into associated slot(s)
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Schedule
summary: "create-type: Create a new Schedule instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Schedule"
}
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'
/Schedule/_history:
get:
tags:
- Schedule
summary: "type-history: Fetch the resource change history for all resources\
\ of type Schedule"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Schedule/{id}/_history:
get:
tags:
- Schedule
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Schedule"
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'
/Schedule/$validate:
get:
tags:
- Schedule
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Schedule/{id}/$validate:
get:
tags:
- Schedule
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Schedule/{id}/$meta-delete:
post:
tags:
- Schedule
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Schedule/{id}/$meta-add:
post:
tags:
- Schedule
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Schedule/$meta:
get:
tags:
- Schedule
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Schedule/{id}/$meta:
get:
tags:
- Schedule
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Schedule/$expunge:
post:
tags:
- Schedule
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Schedule/{id}/$expunge:
post:
tags:
- Schedule
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/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: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: code
in: query
description: Code used in URL
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: derived-from
in: query
description: Original definition for the search parameter
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: type
in: query
description: number | date | string | token | reference | composite | quantity
| uri | special
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: target
in: query
description: Types of resource (if a resource reference)
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: component
in: query
description: Defines how the part works
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
- name: base
in: query
description: The resource type(s) this search parameter applies to
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
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/$validate:
get:
tags:
- SearchParameter
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$validate:
get:
tags:
- SearchParameter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$meta-delete:
post:
tags:
- SearchParameter
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$meta-add:
post:
tags:
- SearchParameter
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/$meta:
get:
tags:
- SearchParameter
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$meta:
get:
tags:
- SearchParameter
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/$expunge:
post:
tags:
- SearchParameter
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SearchParameter/{id}/$expunge:
post:
tags:
- SearchParameter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ServiceRequest/{id}:
get:
tags:
- ServiceRequest
summary: "read-instance: Read ServiceRequest 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:
- ServiceRequest
summary: "update-instance: Update an existing ServiceRequest 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": "ServiceRequest"
}
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:
- ServiceRequest
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:
- ServiceRequest
summary: "instance-patch: Patch a resource instance of type ServiceRequest 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'
/ServiceRequest/{id}/_history/{version_id}:
get:
tags:
- ServiceRequest
summary: "vread-instance: Read ServiceRequest 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'
/ServiceRequest:
get:
tags:
- ServiceRequest
summary: "search-type: Search for ServiceRequest instances"
description: This is a search type
parameters:
- name: authored
in: query
description: Date request signed
style: simple
- name: code
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance * [Condition](condition.html):\
\ Code for the condition * [DeviceRequest](devicerequest.html): Code for\
\ what is being requested/ordered * [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\
\ * [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code * [List](list.html): What the purpose of this list is * [Medication](medication.html):\
\ Returns medications for a specific code * [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code * [MedicationUsage](medicationusage.html):\
\ Return statements of this medication code * [Observation](observation.html):\
\ The code of the observation type * [Procedure](procedure.html): A code\
\ to identify a procedure * [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered "
style: simple
- name: requisition
in: query
description: Composite Request ID
style: simple
- name: subject
in: query
description: Search by subject
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: occurrence
in: query
description: When service should occur
style: simple
- name: based-on
in: query
description: What request fulfills
style: simple
- name: code-reference
in: query
description: What is being requested/ordered
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: specimen
in: query
description: Specimen to be tested
style: simple
- name: code-concept
in: query
description: What is being requested/ordered
style: simple
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
style: simple
- name: requester
in: query
description: Who/what is requesting service
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: performer
in: query
description: Requested performer
style: simple
- name: replaces
in: query
description: What request replaces
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [Composition](composition.html): Context\
\ of the Composition * [DeviceRequest](devicerequest.html): Encounter during\
\ which request was created * [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made * [Flag](flag.html): Alert relevant\
\ during encounter * [List](list.html): Context in which list created *\
\ [NutritionOrder](nutritionorder.html): Return nutrition orders with this\
\ encounter identifier * [Observation](observation.html): Encounter related\
\ to the observation * [Procedure](procedure.html): The Encounter during\
\ which this Procedure was created * [RiskAssessment](riskassessment.html):\
\ Where was assessment performed? * [ServiceRequest](servicerequest.html):\
\ An encounter in which this request is made * [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: priority
in: query
description: routine | urgent | asap | stat
style: simple
- name: intent
in: query
description: proposal | plan | directive | order +
style: simple
- name: performer-type
in: query
description: Performer role
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: body-structure
in: query
description: Body structure Where procedure is going to be done
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: body-site
in: query
description: Where procedure is going to be done
style: simple
- name: category
in: query
description: Classification of service
style: simple
- name: status
in: query
description: draft | active | on-hold | revoked | completed | entered-in-error
| unknown
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ServiceRequest
summary: "create-type: Create a new ServiceRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ServiceRequest"
}
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'
/ServiceRequest/_history:
get:
tags:
- ServiceRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type ServiceRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ServiceRequest/{id}/_history:
get:
tags:
- ServiceRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ServiceRequest"
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'
/ServiceRequest/$validate:
get:
tags:
- ServiceRequest
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ServiceRequest/{id}/$validate:
get:
tags:
- ServiceRequest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ServiceRequest/{id}/$meta-delete:
post:
tags:
- ServiceRequest
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ServiceRequest/{id}/$meta-add:
post:
tags:
- ServiceRequest
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ServiceRequest/$meta:
get:
tags:
- ServiceRequest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ServiceRequest/{id}/$meta:
get:
tags:
- ServiceRequest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ServiceRequest/$expunge:
post:
tags:
- ServiceRequest
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ServiceRequest/{id}/$expunge:
post:
tags:
- ServiceRequest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Slot/{id}:
get:
tags:
- Slot
summary: "read-instance: Read Slot 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:
- Slot
summary: "update-instance: Update an existing Slot 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": "Slot"
}
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:
- Slot
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:
- Slot
summary: "instance-patch: Patch a resource instance of type Slot 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'
/Slot/{id}/_history/{version_id}:
get:
tags:
- Slot
summary: "vread-instance: Read Slot 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'
/Slot:
get:
tags:
- Slot
summary: "search-type: Search for Slot instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: A Slot Identifier
style: simple
- name: specialty
in: query
description: The specialty of a practitioner that would be required to perform
the service requested in this appointment
style: simple
- name: service-category
in: query
description: A broad categorization of the service that is to be performed
during this appointment
style: simple
- name: appointment-type
in: query
description: The style of appointment or patient that may be booked in the
slot (not service type)
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: service-type
in: query
description: The type (by coding) of appointments that can be booked into
the slot
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: start
in: query
description: Appointment date/time.
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: schedule
in: query
description: The Schedule Resource that we are seeking a slot within
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: service-type-reference
in: query
description: The type (by HealthcareService) of appointments that can be booked
into the slot
style: simple
- name: status
in: query
description: The free/busy status of the appointment
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Slot
summary: "create-type: Create a new Slot instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Slot"
}
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'
/Slot/_history:
get:
tags:
- Slot
summary: "type-history: Fetch the resource change history for all resources\
\ of type Slot"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Slot/{id}/_history:
get:
tags:
- Slot
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Slot"
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'
/Slot/$validate:
get:
tags:
- Slot
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Slot/{id}/$validate:
get:
tags:
- Slot
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Slot/{id}/$meta-delete:
post:
tags:
- Slot
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Slot/{id}/$meta-add:
post:
tags:
- Slot
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Slot/$meta:
get:
tags:
- Slot
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Slot/{id}/$meta:
get:
tags:
- Slot
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Slot/$expunge:
post:
tags:
- Slot
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Slot/{id}/$expunge:
post:
tags:
- Slot
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Specimen/{id}:
get:
tags:
- Specimen
summary: "read-instance: Read Specimen 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:
- Specimen
summary: "update-instance: Update an existing Specimen 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": "Specimen"
}
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:
- Specimen
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:
- Specimen
summary: "instance-patch: Patch a resource instance of type Specimen 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'
/Specimen/{id}/_history/{version_id}:
get:
tags:
- Specimen
summary: "vread-instance: Read Specimen 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'
/Specimen:
get:
tags:
- Specimen
summary: "search-type: Search for Specimen instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The unique identifier associated with the specimen
style: simple
- name: parent
in: query
description: The parent of the specimen
style: simple
- name: bodysite
in: query
description: Reference to a resource (by instance)
style: simple
- name: subject
in: query
description: The subject of the specimen
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: collected
in: query
description: The date the specimen was collected
style: simple
- name: accession
in: query
description: The accession number associated with the specimen
style: simple
- name: procedure
in: query
description: The procedure that collected the specimen
style: simple
- name: type
in: query
description: The specimen type
style: simple
- name: collector
in: query
description: Who collected the specimen
style: simple
- name: container-device
in: query
description: The unique identifier associated with the specimen container
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: The patient the specimen comes from
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: available | unavailable | unsatisfactory | entered-in-error
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Specimen
summary: "create-type: Create a new Specimen instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Specimen"
}
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'
/Specimen/_history:
get:
tags:
- Specimen
summary: "type-history: Fetch the resource change history for all resources\
\ of type Specimen"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Specimen/{id}/_history:
get:
tags:
- Specimen
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Specimen"
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'
/Specimen/$validate:
get:
tags:
- Specimen
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Specimen/{id}/$validate:
get:
tags:
- Specimen
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Specimen/{id}/$meta-delete:
post:
tags:
- Specimen
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Specimen/{id}/$meta-add:
post:
tags:
- Specimen
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Specimen/$meta:
get:
tags:
- Specimen
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Specimen/{id}/$meta:
get:
tags:
- Specimen
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Specimen/$expunge:
post:
tags:
- Specimen
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Specimen/{id}/$expunge:
post:
tags:
- Specimen
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SpecimenDefinition/{id}:
get:
tags:
- SpecimenDefinition
summary: "read-instance: Read SpecimenDefinition 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:
- SpecimenDefinition
summary: "update-instance: Update an existing SpecimenDefinition 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": "SpecimenDefinition"
}
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:
- SpecimenDefinition
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:
- SpecimenDefinition
summary: "instance-patch: Patch a resource instance of type SpecimenDefinition\
\ 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'
/SpecimenDefinition/{id}/_history/{version_id}:
get:
tags:
- SpecimenDefinition
summary: "vread-instance: Read SpecimenDefinition 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'
/SpecimenDefinition:
get:
tags:
- SpecimenDefinition
summary: "search-type: Search for SpecimenDefinition instances"
description: This is a search type
parameters:
- name: container
in: query
description: The type of specimen conditioned in container expected by the
lab
style: simple
- name: identifier
in: query
description: The unique identifier associated with the SpecimenDefinition
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: is-derived
in: query
description: Primary specimen (false) or derived specimen (true)
style: simple
- name: experimental
in: query
description: Not for genuine usage (true)
style: simple
- name: type-tested
in: query
description: The type of specimen conditioned for testing
style: simple
- name: title
in: query
description: Human-friendly name of the SpecimenDefinition
style: simple
- name: type
in: query
description: The type of collected specimen
style: simple
- name: url
in: query
description: The uri that identifies the specimen definition
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Publication status of the SpecimenDefinition: draft, active,\
\ retired, unknown"
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SpecimenDefinition
summary: "create-type: Create a new SpecimenDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SpecimenDefinition"
}
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'
/SpecimenDefinition/_history:
get:
tags:
- SpecimenDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type SpecimenDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SpecimenDefinition/{id}/_history:
get:
tags:
- SpecimenDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SpecimenDefinition"
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'
/SpecimenDefinition/$validate:
get:
tags:
- SpecimenDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SpecimenDefinition/{id}/$validate:
get:
tags:
- SpecimenDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SpecimenDefinition/{id}/$meta-delete:
post:
tags:
- SpecimenDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SpecimenDefinition/{id}/$meta-add:
post:
tags:
- SpecimenDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SpecimenDefinition/$meta:
get:
tags:
- SpecimenDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SpecimenDefinition/{id}/$meta:
get:
tags:
- SpecimenDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SpecimenDefinition/$expunge:
post:
tags:
- SpecimenDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SpecimenDefinition/{id}/$expunge:
post:
tags:
- SpecimenDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/{id}:
get:
tags:
- StructureDefinition
summary: "read-instance: Read StructureDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "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:
- StructureDefinition
summary: "update-instance: Update an existing StructureDefinition instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "StructureDefinition"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- StructureDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "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:
- StructureDefinition
summary: "instance-patch: Patch a resource instance of type StructureDefinition\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "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'
/StructureDefinition/{id}/_history/{version_id}:
get:
tags:
- StructureDefinition
summary: "vread-instance: Read StructureDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "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'
/StructureDefinition:
get:
tags:
- StructureDefinition
summary: "search-type: Search for StructureDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: ext-context-type
in: query
description: A type of extension context assigned to the structure definition
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: experimental
in: query
description: "For testing purposes, not real usage"
style: simple
- name: title
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system * [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map * [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition * [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition * [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition * [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ The human-friendly name of the value set "
style: simple
- name: type
in: query
description: Type defined or constrained by this structure
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: path
in: query
description: A path that is constrained in the StructureDefinition
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: base-path
in: query
description: Path that identifies the base element
style: simple
- name: keyword
in: query
description: A code for the StructureDefinition
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: ext-context-expression
in: query
description: An expression of extension context assigned to the structure
definition
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [CodeSystem](codesystem.html): External\
\ identifier for the code system * [ConceptMap](conceptmap.html): External\
\ identifier for the concept map * [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition * [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition * [StructureMap](structuremap.html):\
\ External identifier for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ External identifier for the terminology capabilities * [ValueSet](valueset.html):\
\ External identifier for the value set "
style: simple
- name: valueset
in: query
description: A vocabulary binding reference
style: simple
- name: kind
in: query
description: primitive-type | complex-type | resource | logical
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: abstract
in: query
description: Whether the structure is abstract
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: ext-context
in: query
description: "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text"
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: derivation
in: query
description: specialization | constraint - How relates to base definition
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
- name: base
in: query
description: Definition that this type is constrained/specialized from
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- StructureDefinition
summary: "create-type: Create a new StructureDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "StructureDefinition"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/_history:
get:
tags:
- StructureDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type StructureDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/{id}/_history:
get:
tags:
- StructureDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type StructureDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "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'
/StructureDefinition/$validate:
get:
tags:
- StructureDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/{id}/$validate:
get:
tags:
- StructureDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/{id}/$meta-delete:
post:
tags:
- StructureDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/{id}/$meta-add:
post:
tags:
- StructureDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/$meta:
get:
tags:
- StructureDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/{id}/$meta:
get:
tags:
- StructureDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/$expunge:
post:
tags:
- StructureDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/{id}/$expunge:
post:
tags:
- StructureDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/$snapshot:
get:
tags:
- StructureDefinition
parameters:
- name: definition
in: query
required: false
style: simple
- name: url
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureDefinition/{id}/$snapshot:
get:
tags:
- StructureDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: definition
in: query
required: false
style: simple
- name: url
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureMap/{id}:
get:
tags:
- StructureMap
summary: "read-instance: Read StructureMap 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:
- StructureMap
summary: "update-instance: Update an existing StructureMap 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": "StructureMap"
}
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:
- StructureMap
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:
- StructureMap
summary: "instance-patch: Patch a resource instance of type StructureMap 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'
/StructureMap/{id}/_history/{version_id}:
get:
tags:
- StructureMap
summary: "vread-instance: Read StructureMap 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'
/StructureMap:
get:
tags:
- StructureMap
summary: "search-type: Search for StructureMap instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: title
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system * [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map * [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition * [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition * [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition * [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ The human-friendly name of the value set "
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [CodeSystem](codesystem.html): External\
\ identifier for the code system * [ConceptMap](conceptmap.html): External\
\ identifier for the concept map * [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition * [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition * [StructureMap](structuremap.html):\
\ External identifier for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ External identifier for the terminology capabilities * [ValueSet](valueset.html):\
\ External identifier for the value set "
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- StructureMap
summary: "create-type: Create a new StructureMap instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "StructureMap"
}
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'
/StructureMap/_history:
get:
tags:
- StructureMap
summary: "type-history: Fetch the resource change history for all resources\
\ of type StructureMap"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureMap/{id}/_history:
get:
tags:
- StructureMap
summary: "instance-history: Fetch the resource change history for all resources\
\ of type StructureMap"
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'
/StructureMap/$validate:
get:
tags:
- StructureMap
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureMap/{id}/$validate:
get:
tags:
- StructureMap
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureMap/{id}/$meta-delete:
post:
tags:
- StructureMap
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureMap/{id}/$meta-add:
post:
tags:
- StructureMap
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureMap/$meta:
get:
tags:
- StructureMap
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureMap/{id}/$meta:
get:
tags:
- StructureMap
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureMap/$expunge:
post:
tags:
- StructureMap
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/StructureMap/{id}/$expunge:
post:
tags:
- StructureMap
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/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: identifier
in: query
description: A subscription identifier
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: type
in: query
description: The type of channel for the sent notifications
style: simple
- name: url
in: query
description: The uri that will receive the notifications
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: payload
in: query
description: The mime-type of the notification payload
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: contact
in: query
description: Contact details for the subscription
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The current state of the subscription
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- 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/$trigger-subscription:
post:
tags:
- Subscription
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resourceId",
"valueUri": "example"
}, {
"name": "searchUrl",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/{id}/$trigger-subscription:
post:
tags:
- Subscription
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resourceId",
"valueUri": "example"
}, {
"name": "searchUrl",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/$validate:
get:
tags:
- Subscription
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/{id}/$validate:
get:
tags:
- Subscription
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/{id}/$meta-delete:
post:
tags:
- Subscription
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/{id}/$meta-add:
post:
tags:
- Subscription
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/$meta:
get:
tags:
- Subscription
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/{id}/$meta:
get:
tags:
- Subscription
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/$expunge:
post:
tags:
- Subscription
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Subscription/{id}/$expunge:
post:
tags:
- Subscription
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionStatus/{id}:
get:
tags:
- SubscriptionStatus
summary: "read-instance: Read SubscriptionStatus 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:
- SubscriptionStatus
summary: "update-instance: Update an existing SubscriptionStatus 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": "SubscriptionStatus"
}
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:
- SubscriptionStatus
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:
- SubscriptionStatus
summary: "instance-patch: Patch a resource instance of type SubscriptionStatus\
\ 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'
/SubscriptionStatus/{id}/_history/{version_id}:
get:
tags:
- SubscriptionStatus
summary: "vread-instance: Read SubscriptionStatus 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'
/SubscriptionStatus:
get:
tags:
- SubscriptionStatus
summary: "search-type: Search for SubscriptionStatus instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SubscriptionStatus
summary: "create-type: Create a new SubscriptionStatus instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SubscriptionStatus"
}
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'
/SubscriptionStatus/_history:
get:
tags:
- SubscriptionStatus
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubscriptionStatus"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionStatus/{id}/_history:
get:
tags:
- SubscriptionStatus
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubscriptionStatus"
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'
/SubscriptionStatus/$validate:
get:
tags:
- SubscriptionStatus
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionStatus/{id}/$validate:
get:
tags:
- SubscriptionStatus
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionStatus/{id}/$meta-delete:
post:
tags:
- SubscriptionStatus
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionStatus/{id}/$meta-add:
post:
tags:
- SubscriptionStatus
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionStatus/$meta:
get:
tags:
- SubscriptionStatus
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionStatus/{id}/$meta:
get:
tags:
- SubscriptionStatus
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionStatus/$expunge:
post:
tags:
- SubscriptionStatus
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionStatus/{id}/$expunge:
post:
tags:
- SubscriptionStatus
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionTopic/{id}:
get:
tags:
- SubscriptionTopic
summary: "read-instance: Read SubscriptionTopic 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:
- SubscriptionTopic
summary: "update-instance: Update an existing SubscriptionTopic 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": "SubscriptionTopic"
}
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:
- SubscriptionTopic
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:
- SubscriptionTopic
summary: "instance-patch: Patch a resource instance of type SubscriptionTopic\
\ 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'
/SubscriptionTopic/{id}/_history/{version_id}:
get:
tags:
- SubscriptionTopic
summary: "vread-instance: Read SubscriptionTopic 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'
/SubscriptionTopic:
get:
tags:
- SubscriptionTopic
summary: "search-type: Search for SubscriptionTopic instances"
description: This is a search type
parameters:
- name: date
in: query
description: Date status first applied
style: simple
- name: identifier
in: query
description: Business Identifier for SubscriptionTopic
style: simple
- name: resource
in: query
description: "Allowed Data type or Resource (reference to definition) for\
\ this definition, searches resourceTrigger, eventTrigger, and notificationShape\
\ for matches."
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: derived-or-self
in: query
description: A server defined search that matches either the url or derivedFrom
style: simple
- name: title
in: query
description: Name for this SubscriptionTopic (Human friendly)
style: simple
- name: version
in: query
description: Business version of the SubscriptionTopic
style: simple
- name: url
in: query
description: Logical canonical URL to reference this SubscriptionTopic (globally
unique)
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: draft | active | retired | unknown
style: simple
- name: trigger-description
in: query
description: Text representation of the trigger
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SubscriptionTopic
summary: "create-type: Create a new SubscriptionTopic instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SubscriptionTopic"
}
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'
/SubscriptionTopic/_history:
get:
tags:
- SubscriptionTopic
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubscriptionTopic"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionTopic/{id}/_history:
get:
tags:
- SubscriptionTopic
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubscriptionTopic"
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'
/SubscriptionTopic/$validate:
get:
tags:
- SubscriptionTopic
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionTopic/{id}/$validate:
get:
tags:
- SubscriptionTopic
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionTopic/{id}/$meta-delete:
post:
tags:
- SubscriptionTopic
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionTopic/{id}/$meta-add:
post:
tags:
- SubscriptionTopic
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionTopic/$meta:
get:
tags:
- SubscriptionTopic
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionTopic/{id}/$meta:
get:
tags:
- SubscriptionTopic
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionTopic/$expunge:
post:
tags:
- SubscriptionTopic
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubscriptionTopic/{id}/$expunge:
post:
tags:
- SubscriptionTopic
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Substance/{id}:
get:
tags:
- Substance
summary: "read-instance: Read Substance 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:
- Substance
summary: "update-instance: Update an existing Substance 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": "Substance"
}
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:
- Substance
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:
- Substance
summary: "instance-patch: Patch a resource instance of type Substance 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'
/Substance/{id}/_history/{version_id}:
get:
tags:
- Substance
summary: "vread-instance: Read Substance 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'
/Substance:
get:
tags:
- Substance
summary: "search-type: Search for Substance instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Unique identifier for the substance
style: simple
- name: code
in: query
description: The code of the substance or ingredient
style: simple
- name: quantity
in: query
description: Amount of substance in the package
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: code-reference
in: query
description: A reference to the defining substance
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: substance-reference
in: query
description: A component of the substance
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: expiry
in: query
description: Expiry date of package or container of substance
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: The category of the substance
style: simple
- name: status
in: query
description: active | inactive | entered-in-error
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Substance
summary: "create-type: Create a new Substance instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Substance"
}
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'
/Substance/_history:
get:
tags:
- Substance
summary: "type-history: Fetch the resource change history for all resources\
\ of type Substance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Substance/{id}/_history:
get:
tags:
- Substance
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Substance"
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'
/Substance/$validate:
get:
tags:
- Substance
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Substance/{id}/$validate:
get:
tags:
- Substance
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Substance/{id}/$meta-delete:
post:
tags:
- Substance
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Substance/{id}/$meta-add:
post:
tags:
- Substance
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Substance/$meta:
get:
tags:
- Substance
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Substance/{id}/$meta:
get:
tags:
- Substance
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Substance/$expunge:
post:
tags:
- Substance
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Substance/{id}/$expunge:
post:
tags:
- Substance
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceDefinition/{id}:
get:
tags:
- SubstanceDefinition
summary: "read-instance: Read SubstanceDefinition 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:
- SubstanceDefinition
summary: "update-instance: Update an existing SubstanceDefinition 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": "SubstanceDefinition"
}
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:
- SubstanceDefinition
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:
- SubstanceDefinition
summary: "instance-patch: Patch a resource instance of type SubstanceDefinition\
\ 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'
/SubstanceDefinition/{id}/_history/{version_id}:
get:
tags:
- SubstanceDefinition
summary: "vread-instance: Read SubstanceDefinition 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'
/SubstanceDefinition:
get:
tags:
- SubstanceDefinition
summary: "search-type: Search for SubstanceDefinition instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Identifier by which this substance is known
style: simple
- name: code
in: query
description: The specific code
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: classification
in: query
description: "High or low level categorization, e.g. polymer vs. nucleic acid\
\ or linear vs. branch chain"
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: domain
in: query
description: If the substance applies to only human or veterinary use
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: The actual name
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
responses:
"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:
- SubstanceDefinition
summary: "create-type: Create a new SubstanceDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SubstanceDefinition"
}
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'
/SubstanceDefinition/_history:
get:
tags:
- SubstanceDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceDefinition/{id}/_history:
get:
tags:
- SubstanceDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceDefinition"
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'
/SubstanceDefinition/$validate:
get:
tags:
- SubstanceDefinition
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceDefinition/{id}/$validate:
get:
tags:
- SubstanceDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceDefinition/{id}/$meta-delete:
post:
tags:
- SubstanceDefinition
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceDefinition/{id}/$meta-add:
post:
tags:
- SubstanceDefinition
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceDefinition/$meta:
get:
tags:
- SubstanceDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceDefinition/{id}/$meta:
get:
tags:
- SubstanceDefinition
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceDefinition/$expunge:
post:
tags:
- SubstanceDefinition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceDefinition/{id}/$expunge:
post:
tags:
- SubstanceDefinition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceNucleicAcid/{id}:
get:
tags:
- SubstanceNucleicAcid
summary: "read-instance: Read SubstanceNucleicAcid 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:
- SubstanceNucleicAcid
summary: "update-instance: Update an existing SubstanceNucleicAcid 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": "SubstanceNucleicAcid"
}
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:
- SubstanceNucleicAcid
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:
- SubstanceNucleicAcid
summary: "instance-patch: Patch a resource instance of type SubstanceNucleicAcid\
\ 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'
/SubstanceNucleicAcid/{id}/_history/{version_id}:
get:
tags:
- SubstanceNucleicAcid
summary: "vread-instance: Read SubstanceNucleicAcid 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'
/SubstanceNucleicAcid:
get:
tags:
- SubstanceNucleicAcid
summary: "search-type: Search for SubstanceNucleicAcid instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SubstanceNucleicAcid
summary: "create-type: Create a new SubstanceNucleicAcid instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SubstanceNucleicAcid"
}
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'
/SubstanceNucleicAcid/_history:
get:
tags:
- SubstanceNucleicAcid
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceNucleicAcid"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceNucleicAcid/{id}/_history:
get:
tags:
- SubstanceNucleicAcid
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceNucleicAcid"
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'
/SubstanceNucleicAcid/$validate:
get:
tags:
- SubstanceNucleicAcid
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceNucleicAcid/{id}/$validate:
get:
tags:
- SubstanceNucleicAcid
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceNucleicAcid/{id}/$meta-delete:
post:
tags:
- SubstanceNucleicAcid
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceNucleicAcid/{id}/$meta-add:
post:
tags:
- SubstanceNucleicAcid
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceNucleicAcid/$meta:
get:
tags:
- SubstanceNucleicAcid
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceNucleicAcid/{id}/$meta:
get:
tags:
- SubstanceNucleicAcid
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceNucleicAcid/$expunge:
post:
tags:
- SubstanceNucleicAcid
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceNucleicAcid/{id}/$expunge:
post:
tags:
- SubstanceNucleicAcid
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstancePolymer/{id}:
get:
tags:
- SubstancePolymer
summary: "read-instance: Read SubstancePolymer 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:
- SubstancePolymer
summary: "update-instance: Update an existing SubstancePolymer 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": "SubstancePolymer"
}
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:
- SubstancePolymer
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:
- SubstancePolymer
summary: "instance-patch: Patch a resource instance of type SubstancePolymer\
\ 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'
/SubstancePolymer/{id}/_history/{version_id}:
get:
tags:
- SubstancePolymer
summary: "vread-instance: Read SubstancePolymer 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'
/SubstancePolymer:
get:
tags:
- SubstancePolymer
summary: "search-type: Search for SubstancePolymer instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SubstancePolymer
summary: "create-type: Create a new SubstancePolymer instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SubstancePolymer"
}
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'
/SubstancePolymer/_history:
get:
tags:
- SubstancePolymer
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstancePolymer"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstancePolymer/{id}/_history:
get:
tags:
- SubstancePolymer
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstancePolymer"
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'
/SubstancePolymer/$validate:
get:
tags:
- SubstancePolymer
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstancePolymer/{id}/$validate:
get:
tags:
- SubstancePolymer
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstancePolymer/{id}/$meta-delete:
post:
tags:
- SubstancePolymer
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstancePolymer/{id}/$meta-add:
post:
tags:
- SubstancePolymer
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstancePolymer/$meta:
get:
tags:
- SubstancePolymer
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstancePolymer/{id}/$meta:
get:
tags:
- SubstancePolymer
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstancePolymer/$expunge:
post:
tags:
- SubstancePolymer
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstancePolymer/{id}/$expunge:
post:
tags:
- SubstancePolymer
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceProtein/{id}:
get:
tags:
- SubstanceProtein
summary: "read-instance: Read SubstanceProtein 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:
- SubstanceProtein
summary: "update-instance: Update an existing SubstanceProtein 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": "SubstanceProtein"
}
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:
- SubstanceProtein
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:
- SubstanceProtein
summary: "instance-patch: Patch a resource instance of type SubstanceProtein\
\ 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'
/SubstanceProtein/{id}/_history/{version_id}:
get:
tags:
- SubstanceProtein
summary: "vread-instance: Read SubstanceProtein 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'
/SubstanceProtein:
get:
tags:
- SubstanceProtein
summary: "search-type: Search for SubstanceProtein instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SubstanceProtein
summary: "create-type: Create a new SubstanceProtein instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SubstanceProtein"
}
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'
/SubstanceProtein/_history:
get:
tags:
- SubstanceProtein
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceProtein"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceProtein/{id}/_history:
get:
tags:
- SubstanceProtein
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceProtein"
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'
/SubstanceProtein/$validate:
get:
tags:
- SubstanceProtein
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceProtein/{id}/$validate:
get:
tags:
- SubstanceProtein
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceProtein/{id}/$meta-delete:
post:
tags:
- SubstanceProtein
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceProtein/{id}/$meta-add:
post:
tags:
- SubstanceProtein
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceProtein/$meta:
get:
tags:
- SubstanceProtein
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceProtein/{id}/$meta:
get:
tags:
- SubstanceProtein
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceProtein/$expunge:
post:
tags:
- SubstanceProtein
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceProtein/{id}/$expunge:
post:
tags:
- SubstanceProtein
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceReferenceInformation/{id}:
get:
tags:
- SubstanceReferenceInformation
summary: "read-instance: Read SubstanceReferenceInformation 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:
- SubstanceReferenceInformation
summary: "update-instance: Update an existing SubstanceReferenceInformation\
\ 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": "SubstanceReferenceInformation"
}
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:
- SubstanceReferenceInformation
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:
- SubstanceReferenceInformation
summary: "instance-patch: Patch a resource instance of type SubstanceReferenceInformation\
\ 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'
/SubstanceReferenceInformation/{id}/_history/{version_id}:
get:
tags:
- SubstanceReferenceInformation
summary: "vread-instance: Read SubstanceReferenceInformation 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'
/SubstanceReferenceInformation:
get:
tags:
- SubstanceReferenceInformation
summary: "search-type: Search for SubstanceReferenceInformation instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SubstanceReferenceInformation
summary: "create-type: Create a new SubstanceReferenceInformation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SubstanceReferenceInformation"
}
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'
/SubstanceReferenceInformation/_history:
get:
tags:
- SubstanceReferenceInformation
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceReferenceInformation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceReferenceInformation/{id}/_history:
get:
tags:
- SubstanceReferenceInformation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceReferenceInformation"
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'
/SubstanceReferenceInformation/$validate:
get:
tags:
- SubstanceReferenceInformation
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceReferenceInformation/{id}/$validate:
get:
tags:
- SubstanceReferenceInformation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceReferenceInformation/{id}/$meta-delete:
post:
tags:
- SubstanceReferenceInformation
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceReferenceInformation/{id}/$meta-add:
post:
tags:
- SubstanceReferenceInformation
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceReferenceInformation/$meta:
get:
tags:
- SubstanceReferenceInformation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceReferenceInformation/{id}/$meta:
get:
tags:
- SubstanceReferenceInformation
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceReferenceInformation/$expunge:
post:
tags:
- SubstanceReferenceInformation
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceReferenceInformation/{id}/$expunge:
post:
tags:
- SubstanceReferenceInformation
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceSourceMaterial/{id}:
get:
tags:
- SubstanceSourceMaterial
summary: "read-instance: Read SubstanceSourceMaterial 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:
- SubstanceSourceMaterial
summary: "update-instance: Update an existing SubstanceSourceMaterial 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": "SubstanceSourceMaterial"
}
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:
- SubstanceSourceMaterial
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:
- SubstanceSourceMaterial
summary: "instance-patch: Patch a resource instance of type SubstanceSourceMaterial\
\ 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'
/SubstanceSourceMaterial/{id}/_history/{version_id}:
get:
tags:
- SubstanceSourceMaterial
summary: "vread-instance: Read SubstanceSourceMaterial 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'
/SubstanceSourceMaterial:
get:
tags:
- SubstanceSourceMaterial
summary: "search-type: Search for SubstanceSourceMaterial instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SubstanceSourceMaterial
summary: "create-type: Create a new SubstanceSourceMaterial instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SubstanceSourceMaterial"
}
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'
/SubstanceSourceMaterial/_history:
get:
tags:
- SubstanceSourceMaterial
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceSourceMaterial"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceSourceMaterial/{id}/_history:
get:
tags:
- SubstanceSourceMaterial
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceSourceMaterial"
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'
/SubstanceSourceMaterial/$validate:
get:
tags:
- SubstanceSourceMaterial
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceSourceMaterial/{id}/$validate:
get:
tags:
- SubstanceSourceMaterial
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceSourceMaterial/{id}/$meta-delete:
post:
tags:
- SubstanceSourceMaterial
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceSourceMaterial/{id}/$meta-add:
post:
tags:
- SubstanceSourceMaterial
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceSourceMaterial/$meta:
get:
tags:
- SubstanceSourceMaterial
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceSourceMaterial/{id}/$meta:
get:
tags:
- SubstanceSourceMaterial
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceSourceMaterial/$expunge:
post:
tags:
- SubstanceSourceMaterial
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SubstanceSourceMaterial/{id}/$expunge:
post:
tags:
- SubstanceSourceMaterial
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyDelivery/{id}:
get:
tags:
- SupplyDelivery
summary: "read-instance: Read SupplyDelivery 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:
- SupplyDelivery
summary: "update-instance: Update an existing SupplyDelivery 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": "SupplyDelivery"
}
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:
- SupplyDelivery
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:
- SupplyDelivery
summary: "instance-patch: Patch a resource instance of type SupplyDelivery 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'
/SupplyDelivery/{id}/_history/{version_id}:
get:
tags:
- SupplyDelivery
summary: "vread-instance: Read SupplyDelivery 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'
/SupplyDelivery:
get:
tags:
- SupplyDelivery
summary: "search-type: Search for SupplyDelivery instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: receiver
in: query
description: Who collected the Supply
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: supplier
in: query
description: Dispenser
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: in-progress | completed | abandoned | entered-in-error
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SupplyDelivery
summary: "create-type: Create a new SupplyDelivery instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SupplyDelivery"
}
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'
/SupplyDelivery/_history:
get:
tags:
- SupplyDelivery
summary: "type-history: Fetch the resource change history for all resources\
\ of type SupplyDelivery"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyDelivery/{id}/_history:
get:
tags:
- SupplyDelivery
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SupplyDelivery"
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'
/SupplyDelivery/$validate:
get:
tags:
- SupplyDelivery
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyDelivery/{id}/$validate:
get:
tags:
- SupplyDelivery
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyDelivery/{id}/$meta-delete:
post:
tags:
- SupplyDelivery
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyDelivery/{id}/$meta-add:
post:
tags:
- SupplyDelivery
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyDelivery/$meta:
get:
tags:
- SupplyDelivery
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyDelivery/{id}/$meta:
get:
tags:
- SupplyDelivery
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyDelivery/$expunge:
post:
tags:
- SupplyDelivery
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyDelivery/{id}/$expunge:
post:
tags:
- SupplyDelivery
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyRequest/{id}:
get:
tags:
- SupplyRequest
summary: "read-instance: Read SupplyRequest 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:
- SupplyRequest
summary: "update-instance: Update an existing SupplyRequest 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": "SupplyRequest"
}
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:
- SupplyRequest
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:
- SupplyRequest
summary: "instance-patch: Patch a resource instance of type SupplyRequest 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'
/SupplyRequest/{id}/_history/{version_id}:
get:
tags:
- SupplyRequest
summary: "vread-instance: Read SupplyRequest 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'
/SupplyRequest:
get:
tags:
- SupplyRequest
summary: "search-type: Search for SupplyRequest instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded * [CarePlan](careplan.html):\
\ Time period plan covers * [CareTeam](careteam.html): A date within the\
\ coverage time period. * [ClinicalImpression](clinicalimpression.html):\
\ When the assessment was documented * [Composition](composition.html):\
\ Composition editing time * [Consent](consent.html): When consent was agreed\
\ to * [DiagnosticReport](diagnosticreport.html): The clinically relevant\
\ time of the report * [Encounter](encounter.html): A date within the actualPeriod\
\ the Encounter lasted * [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period * [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated * [Flag](flag.html): Time period\
\ when flag is active * [Immunization](immunization.html): Vaccination \
\ (non)-Administration Date * [List](list.html): When the list was prepared\
\ * [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period * [Procedure](procedure.html):\
\ When the procedure occurred or is occurring * [RiskAssessment](riskassessment.html):\
\ When was assessment made? * [SupplyRequest](supplyrequest.html): When\
\ the request was made "
style: simple
- name: requester
in: query
description: Individual making the request
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: subject
in: query
description: The destination of the supply
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: supplier
in: query
description: Who is intended to fulfill the request
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: category
in: query
description: "The kind of supply (central, non-stock, etc.)"
style: simple
- name: status
in: query
description: draft | active | suspended +
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- SupplyRequest
summary: "create-type: Create a new SupplyRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "SupplyRequest"
}
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'
/SupplyRequest/_history:
get:
tags:
- SupplyRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type SupplyRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyRequest/{id}/_history:
get:
tags:
- SupplyRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SupplyRequest"
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'
/SupplyRequest/$validate:
get:
tags:
- SupplyRequest
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyRequest/{id}/$validate:
get:
tags:
- SupplyRequest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyRequest/{id}/$meta-delete:
post:
tags:
- SupplyRequest
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyRequest/{id}/$meta-add:
post:
tags:
- SupplyRequest
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyRequest/$meta:
get:
tags:
- SupplyRequest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyRequest/{id}/$meta:
get:
tags:
- SupplyRequest
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyRequest/$expunge:
post:
tags:
- SupplyRequest
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/SupplyRequest/{id}/$expunge:
post:
tags:
- SupplyRequest
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Task/{id}:
get:
tags:
- Task
summary: "read-instance: Read Task 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:
- Task
summary: "update-instance: Update an existing Task 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": "Task"
}
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:
- Task
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:
- Task
summary: "instance-patch: Patch a resource instance of type Task 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'
/Task/{id}/_history/{version_id}:
get:
tags:
- Task
summary: "vread-instance: Read Task 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'
/Task:
get:
tags:
- Task
summary: "search-type: Search for Task instances"
description: This is a search type
parameters:
- name: code
in: query
description: Search by task code
style: simple
- name: subject
in: query
description: Search by subject
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: focus
in: query
description: Search by task focus
style: simple
- name: part-of
in: query
description: Search by task this task is part of
style: simple
- name: output
in: query
description: Search by task output
style: simple
- name: group-identifier
in: query
description: Search by group identifier
style: simple
- name: based-on
in: query
description: Search by requests this task is based on
style: simple
- name: patient
in: query
description: Search by patient
style: simple
- name: modified
in: query
description: Search by last modification date
style: simple
- name: owner
in: query
description: Search by task owner
style: simple
- name: requester
in: query
description: Search by task requester
style: simple
- name: business-status
in: query
description: Search by business status
style: simple
- name: identifier
in: query
description: Search for a task instance by its business identifier
style: simple
- name: period
in: query
description: Search by period Task is/was underway
style: simple
- name: performer
in: query
description: "Search by recommended type of performer (e.g., Requester, Performer,\
\ Scheduler)."
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: Search by encounter
style: simple
- name: authored-on
in: query
description: Search by creation date
style: simple
- name: priority
in: query
description: Search by task priority
style: simple
- name: intent
in: query
description: Search by task intent
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: Search by task status
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Task
summary: "create-type: Create a new Task instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Task"
}
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'
/Task/_history:
get:
tags:
- Task
summary: "type-history: Fetch the resource change history for all resources\
\ of type Task"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Task/{id}/_history:
get:
tags:
- Task
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Task"
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'
/Task/$validate:
get:
tags:
- Task
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Task/{id}/$validate:
get:
tags:
- Task
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Task/{id}/$meta-delete:
post:
tags:
- Task
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Task/{id}/$meta-add:
post:
tags:
- Task
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Task/$meta:
get:
tags:
- Task
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Task/{id}/$meta:
get:
tags:
- Task
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Task/$expunge:
post:
tags:
- Task
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Task/{id}/$expunge:
post:
tags:
- Task
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TerminologyCapabilities/{id}:
get:
tags:
- TerminologyCapabilities
summary: "read-instance: Read TerminologyCapabilities 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:
- TerminologyCapabilities
summary: "update-instance: Update an existing TerminologyCapabilities 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": "TerminologyCapabilities"
}
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:
- TerminologyCapabilities
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:
- TerminologyCapabilities
summary: "instance-patch: Patch a resource instance of type TerminologyCapabilities\
\ 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'
/TerminologyCapabilities/{id}/_history/{version_id}:
get:
tags:
- TerminologyCapabilities
summary: "vread-instance: Read TerminologyCapabilities 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'
/TerminologyCapabilities:
get:
tags:
- TerminologyCapabilities
summary: "search-type: Search for TerminologyCapabilities instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: title
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system * [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map * [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition * [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition * [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition * [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ The human-friendly name of the value set "
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [CodeSystem](codesystem.html): External\
\ identifier for the code system * [ConceptMap](conceptmap.html): External\
\ identifier for the concept map * [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition * [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition * [StructureMap](structuremap.html):\
\ External identifier for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ External identifier for the terminology capabilities * [ValueSet](valueset.html):\
\ External identifier for the value set "
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- TerminologyCapabilities
summary: "create-type: Create a new TerminologyCapabilities instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "TerminologyCapabilities"
}
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'
/TerminologyCapabilities/_history:
get:
tags:
- TerminologyCapabilities
summary: "type-history: Fetch the resource change history for all resources\
\ of type TerminologyCapabilities"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TerminologyCapabilities/{id}/_history:
get:
tags:
- TerminologyCapabilities
summary: "instance-history: Fetch the resource change history for all resources\
\ of type TerminologyCapabilities"
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'
/TerminologyCapabilities/$validate:
get:
tags:
- TerminologyCapabilities
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TerminologyCapabilities/{id}/$validate:
get:
tags:
- TerminologyCapabilities
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TerminologyCapabilities/{id}/$meta-delete:
post:
tags:
- TerminologyCapabilities
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TerminologyCapabilities/{id}/$meta-add:
post:
tags:
- TerminologyCapabilities
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TerminologyCapabilities/$meta:
get:
tags:
- TerminologyCapabilities
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TerminologyCapabilities/{id}/$meta:
get:
tags:
- TerminologyCapabilities
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TerminologyCapabilities/$expunge:
post:
tags:
- TerminologyCapabilities
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TerminologyCapabilities/{id}/$expunge:
post:
tags:
- TerminologyCapabilities
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestReport/{id}:
get:
tags:
- TestReport
summary: "read-instance: Read TestReport 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:
- TestReport
summary: "update-instance: Update an existing TestReport 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": "TestReport"
}
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:
- TestReport
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:
- TestReport
summary: "instance-patch: Patch a resource instance of type TestReport 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'
/TestReport/{id}/_history/{version_id}:
get:
tags:
- TestReport
summary: "vread-instance: Read TestReport 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'
/TestReport:
get:
tags:
- TestReport
summary: "search-type: Search for TestReport instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: An external identifier for the test report
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: tester
in: query
description: The name of the testing organization
style: simple
- name: participant
in: query
description: The reference to a participant in the test execution
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: result
in: query
description: The result disposition of the test execution
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: testscript
in: query
description: The test script executed to produce this report
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: issued
in: query
description: The test report generation date
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- TestReport
summary: "create-type: Create a new TestReport instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "TestReport"
}
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'
/TestReport/_history:
get:
tags:
- TestReport
summary: "type-history: Fetch the resource change history for all resources\
\ of type TestReport"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestReport/{id}/_history:
get:
tags:
- TestReport
summary: "instance-history: Fetch the resource change history for all resources\
\ of type TestReport"
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'
/TestReport/$validate:
get:
tags:
- TestReport
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestReport/{id}/$validate:
get:
tags:
- TestReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestReport/{id}/$meta-delete:
post:
tags:
- TestReport
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestReport/{id}/$meta-add:
post:
tags:
- TestReport
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestReport/$meta:
get:
tags:
- TestReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestReport/{id}/$meta:
get:
tags:
- TestReport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestReport/$expunge:
post:
tags:
- TestReport
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestReport/{id}/$expunge:
post:
tags:
- TestReport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestScript/{id}:
get:
tags:
- TestScript
summary: "read-instance: Read TestScript 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:
- TestScript
summary: "update-instance: Update an existing TestScript 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": "TestScript"
}
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:
- TestScript
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:
- TestScript
summary: "instance-patch: Patch a resource instance of type TestScript 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'
/TestScript/{id}/_history/{version_id}:
get:
tags:
- TestScript
summary: "vread-instance: Read TestScript 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'
/TestScript:
get:
tags:
- TestScript
summary: "search-type: Search for TestScript instances"
description: This is a search type
parameters:
- name: date
in: query
description: The test script publication date
style: simple
- name: context-type-value
in: query
description: A use context type and value assigned to the test script
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: Intended jurisdiction for the test script
style: simple
- name: description
in: query
description: The description of the test script
style: simple
- name: testscript-capability
in: query
description: TestScript required and validated capability
style: simple
- name: context-type
in: query
description: A type of use context assigned to the test script
style: simple
- name: title
in: query
description: The human-friendly name of the test script
style: simple
- name: scope-artifact
in: query
description: The artifact under test
style: simple
- name: context-quantity
in: query
description: A quantity- or range-valued use context assigned to the test
script
style: simple
- name: context
in: query
description: A use context assigned to the test script
style: simple
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the test script
style: simple
- name: identifier
in: query
description: External identifier for the test script
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: scope-artifact-phase
in: query
description: The artifact under test and phase of testing
style: simple
- name: version
in: query
description: The business version of the test script
style: simple
- name: scope-artifact-conformance
in: query
description: The artifact under test and conformance testing expectation
style: simple
- name: url
in: query
description: The uri that identifies the test script
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: Computationally friendly name of the test script
style: simple
- name: publisher
in: query
description: Name of the publisher of the test script
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The current status of the test script
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- TestScript
summary: "create-type: Create a new TestScript instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "TestScript"
}
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'
/TestScript/_history:
get:
tags:
- TestScript
summary: "type-history: Fetch the resource change history for all resources\
\ of type TestScript"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestScript/{id}/_history:
get:
tags:
- TestScript
summary: "instance-history: Fetch the resource change history for all resources\
\ of type TestScript"
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'
/TestScript/$validate:
get:
tags:
- TestScript
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestScript/{id}/$validate:
get:
tags:
- TestScript
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestScript/{id}/$meta-delete:
post:
tags:
- TestScript
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestScript/{id}/$meta-add:
post:
tags:
- TestScript
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestScript/$meta:
get:
tags:
- TestScript
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestScript/{id}/$meta:
get:
tags:
- TestScript
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestScript/$expunge:
post:
tags:
- TestScript
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/TestScript/{id}/$expunge:
post:
tags:
- TestScript
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Transport/{id}:
get:
tags:
- Transport
summary: "read-instance: Read Transport 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:
- Transport
summary: "update-instance: Update an existing Transport 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": "Transport"
}
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:
- Transport
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:
- Transport
summary: "instance-patch: Patch a resource instance of type Transport 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'
/Transport/{id}/_history/{version_id}:
get:
tags:
- Transport
summary: "vread-instance: Read Transport 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'
/Transport:
get:
tags:
- Transport
summary: "search-type: Search for Transport instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: External identifier
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: in-progress | completed | entered-in-error
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- Transport
summary: "create-type: Create a new Transport instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Transport"
}
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'
/Transport/_history:
get:
tags:
- Transport
summary: "type-history: Fetch the resource change history for all resources\
\ of type Transport"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Transport/{id}/_history:
get:
tags:
- Transport
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Transport"
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'
/Transport/$validate:
get:
tags:
- Transport
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Transport/{id}/$validate:
get:
tags:
- Transport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Transport/{id}/$meta-delete:
post:
tags:
- Transport
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Transport/{id}/$meta-add:
post:
tags:
- Transport
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Transport/$meta:
get:
tags:
- Transport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Transport/{id}/$meta:
get:
tags:
- Transport
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Transport/$expunge:
post:
tags:
- Transport
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/Transport/{id}/$expunge:
post:
tags:
- Transport
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}:
get:
tags:
- ValueSet
summary: "read-instance: Read ValueSet 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:
- ValueSet
summary: "update-instance: Update an existing ValueSet 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": "ValueSet"
}
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:
- ValueSet
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:
- ValueSet
summary: "instance-patch: Patch a resource instance of type ValueSet 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'
/ValueSet/{id}/_history/{version_id}:
get:
tags:
- ValueSet
summary: "vread-instance: Read ValueSet 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'
/ValueSet:
get:
tags:
- ValueSet
summary: "search-type: Search for ValueSet instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date * [CodeSystem](codesystem.html):\
\ The code system publication date * [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date * [ConceptMap](conceptmap.html):\
\ The concept map publication date * [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date * [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date * [MessageDefinition](messagedefinition.html):\
\ The message definition publication date * [NamingSystem](namingsystem.html):\
\ The naming system publication date * [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date * [SearchParameter](searchparameter.html):\
\ The search parameter publication date * [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date * [StructureMap](structuremap.html):\
\ The structure map publication date * [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date * [ValueSet](valueset.html):\
\ The value set publication date "
style: simple
- name: code
in: query
description: This special parameter searches for codes in the value set. See
additional notes on the ValueSet resource
style: simple
- name: context-type-value
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context type and value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition *\
\ [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map * [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context type and value assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context type and value assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context type and value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: jurisdiction
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement * [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system * [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map * [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition * [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition * [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system * [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition * [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter * [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition * [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities * [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set "
style: simple
- name: description
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement * [CodeSystem](codesystem.html):\
\ The description of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition * [ConceptMap](conceptmap.html):\
\ The description of the concept map * [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The description of the message definition * [NamingSystem](namingsystem.html):\
\ The description of the naming system * [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition * [SearchParameter](searchparameter.html):\
\ The description of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition * [StructureMap](structuremap.html):\
\ The description of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities * [ValueSet](valueset.html):\
\ The description of the value set "
style: simple
- name: derived-from
in: query
description: A resource that the ValueSet is derived from
style: simple
- name: context-type
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A type of use context assigned to the value set "
style: simple
- name: predecessor
in: query
description: The predecessor of the ValueSet
style: simple
- name: title
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system * [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map * [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition * [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition * [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition * [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ The human-friendly name of the value set "
style: simple
- name: reference
in: query
description: A code system included or excluded in the value set or an imported
value set
style: simple
- name: context-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\
\ * [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\
\ * [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\
\ * [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\
\ * [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\
\ * [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\
\ * [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\
\ * [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set "
style: simple
- name: effective
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ The time during which the CodeSystem is intended to be in use\r\n* [ConceptMap](conceptmap.html):\
\ The time during which the ConceptMap is intended to be in use\r\n* [NamingSystem](namingsystem.html):\
\ The time during which the NamingSystem is intended to be in use\r\n* [ValueSet](valueset.html):\
\ The time during which the ValueSet is intended to be in use\r\n"
style: simple
- name: context
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement * [CodeSystem](codesystem.html):\
\ A use context assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition * [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map * [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide * [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition * [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition * [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter * [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition * [StructureMap](structuremap.html):\
\ A use context assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities * [ValueSet](valueset.html):\
\ A use context assigned to the value set "
style: simple
- name: end
in: query
description: Optional Extensions Element
style: simple
- name: keyword
in: query
description: Optional Extensions Element
style: simple
- name: context-type-quantity
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement * [CodeSystem](codesystem.html): A use context type\
\ and quantity- or range-based value assigned to the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition * [ConceptMap](conceptmap.html): A use context\
\ type and quantity- or range-based value assigned to the concept map *\
\ [GraphDefinition](graphdefinition.html): A use context type and quantity-\
\ or range-based value assigned to the graph definition * [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide * [MessageDefinition](messagedefinition.html): A\
\ use context type and quantity- or range-based value assigned to the message\
\ definition * [NamingSystem](namingsystem.html): A use context type and\
\ quantity- or range-based value assigned to the naming system * [OperationDefinition](operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition * [SearchParameter](searchparameter.html): A use\
\ context type and quantity- or range-based value assigned to the search\
\ parameter * [StructureDefinition](structuredefinition.html): A use context\
\ type and quantity- or range-based value assigned to the structure definition\
\ * [StructureMap](structuremap.html): A use context type and quantity-\
\ or range-based value assigned to the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities * [ValueSet](valueset.html): A use context type\
\ and quantity- or range-based value assigned to the value set "
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [CodeSystem](codesystem.html): External\
\ identifier for the code system * [ConceptMap](conceptmap.html): External\
\ identifier for the concept map * [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition * [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition * [StructureMap](structuremap.html):\
\ External identifier for the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ External identifier for the terminology capabilities * [ValueSet](valueset.html):\
\ External identifier for the value set "
style: simple
- name: workflow
in: query
description: Optional Extensions Element
style: simple
- name: author
in: query
description: Optional Extensions Element
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: version
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement * [CodeSystem](codesystem.html):\
\ The business version of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition * [ConceptMap](conceptmap.html):\
\ The business version of the concept map * [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition * [NamingSystem](namingsystem.html):\
\ The business version of the naming system * [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition * [SearchParameter](searchparameter.html):\
\ The business version of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition * [StructureMap](structuremap.html):\
\ The business version of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities * [ValueSet](valueset.html):\
\ The business version of the value set "
style: simple
- name: url
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement * [CodeSystem](codesystem.html):\
\ The uri that identifies the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition * [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map * [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition * [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition * [NamingSystem](namingsystem.html):\
\ The uri that identifies the naming system * [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition * [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter * [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition * [StructureMap](structuremap.html):\
\ The uri that identifies the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities * [ValueSet](valueset.html):\
\ The uri that identifies the value set "
style: simple
- name: expansion
in: query
description: Identifies the value set expansion (business identifier)
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement * [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition * [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map * [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition * [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system * [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition * [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition * [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities * [ValueSet](valueset.html):\
\ Computationally friendly name of the value set "
style: simple
- name: publisher
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement * [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition * [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map * [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition * [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition * [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system * [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition * [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter * [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition * [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities * [ValueSet](valueset.html):\
\ Name of the publisher of the value set "
style: simple
- name: topic
in: query
description: Topics associated with the ValueSet
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: "Multiple Resources: * [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement * [CodeSystem](codesystem.html):\
\ The current status of the code system * [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition * [ConceptMap](conceptmap.html):\
\ The current status of the concept map * [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition * [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide * [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition * [NamingSystem](namingsystem.html):\
\ The current status of the naming system * [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition * [SearchParameter](searchparameter.html):\
\ The current status of the search parameter * [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition * [StructureMap](structuremap.html):\
\ The current status of the structure map * [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities * [ValueSet](valueset.html):\
\ The current status of the value set "
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- ValueSet
summary: "create-type: Create a new ValueSet instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "ValueSet"
}
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'
/ValueSet/_history:
get:
tags:
- ValueSet
summary: "type-history: Fetch the resource change history for all resources\
\ of type ValueSet"
responses:
"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}/_history:
get:
tags:
- ValueSet
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ValueSet"
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'
/ValueSet/$validate-code:
get:
tags:
- ValueSet
parameters:
- name: url
in: query
required: false
style: simple
- name: version
in: query
required: false
style: simple
- name: code
in: query
required: false
style: simple
- name: display
in: query
required: false
style: simple
- name: coding
in: query
required: false
style: simple
- name: codeableConcept
in: query
required: false
style: simple
- name: result
in: query
required: true
style: simple
- name: message
in: query
required: false
style: simple
- name: display
in: query
required: false
style: simple
- name: valueSetVersion
in: query
required: false
style: simple
- name: system
in: query
required: false
style: simple
- name: systemVersion
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$validate-code:
get:
tags:
- ValueSet
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: url
in: query
required: false
style: simple
- name: version
in: query
required: false
style: simple
- name: code
in: query
required: false
style: simple
- name: display
in: query
required: false
style: simple
- name: coding
in: query
required: false
style: simple
- name: codeableConcept
in: query
required: false
style: simple
- name: result
in: query
required: true
style: simple
- name: message
in: query
required: false
style: simple
- name: display
in: query
required: false
style: simple
- name: valueSetVersion
in: query
required: false
style: simple
- name: system
in: query
required: false
style: simple
- name: systemVersion
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$invalidate-expansion:
post:
tags:
- ValueSet
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "message"
} ]
}
responses:
"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
parameters:
- name: valueSet
in: query
required: false
style: simple
- name: url
in: query
required: false
style: simple
- name: valueSetVersion
in: query
required: false
style: simple
- name: filter
in: query
required: false
style: simple
- name: context
in: query
required: false
style: simple
- name: contextDirection
in: query
required: false
style: simple
- name: offset
in: query
required: false
style: simple
- name: count
in: query
required: false
style: simple
- name: displayLanguage
in: query
required: false
style: simple
- name: includeHierarchy
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$expand:
get:
tags:
- ValueSet
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: valueSet
in: query
required: false
style: simple
- name: url
in: query
required: false
style: simple
- name: valueSetVersion
in: query
required: false
style: simple
- name: filter
in: query
required: false
style: simple
- name: context
in: query
required: false
style: simple
- name: contextDirection
in: query
required: false
style: simple
- name: offset
in: query
required: false
style: simple
- name: count
in: query
required: false
style: simple
- name: displayLanguage
in: query
required: false
style: simple
- name: includeHierarchy
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/$validate:
get:
tags:
- ValueSet
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$validate:
get:
tags:
- ValueSet
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$meta-delete:
post:
tags:
- ValueSet
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$meta-add:
post:
tags:
- ValueSet
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/$meta:
get:
tags:
- ValueSet
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$meta:
get:
tags:
- ValueSet
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/$expunge:
post:
tags:
- ValueSet
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/ValueSet/{id}/$expunge:
post:
tags:
- ValueSet
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VerificationResult/{id}:
get:
tags:
- VerificationResult
summary: "read-instance: Read VerificationResult 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:
- VerificationResult
summary: "update-instance: Update an existing VerificationResult 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": "VerificationResult"
}
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:
- VerificationResult
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:
- VerificationResult
summary: "instance-patch: Patch a resource instance of type VerificationResult\
\ 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'
/VerificationResult/{id}/_history/{version_id}:
get:
tags:
- VerificationResult
summary: "vread-instance: Read VerificationResult 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'
/VerificationResult:
get:
tags:
- VerificationResult
summary: "search-type: Search for VerificationResult instances"
description: This is a search type
parameters:
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: target
in: query
description: A resource that was validated
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- VerificationResult
summary: "create-type: Create a new VerificationResult instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "VerificationResult"
}
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'
/VerificationResult/_history:
get:
tags:
- VerificationResult
summary: "type-history: Fetch the resource change history for all resources\
\ of type VerificationResult"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VerificationResult/{id}/_history:
get:
tags:
- VerificationResult
summary: "instance-history: Fetch the resource change history for all resources\
\ of type VerificationResult"
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'
/VerificationResult/$validate:
get:
tags:
- VerificationResult
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VerificationResult/{id}/$validate:
get:
tags:
- VerificationResult
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VerificationResult/{id}/$meta-delete:
post:
tags:
- VerificationResult
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VerificationResult/{id}/$meta-add:
post:
tags:
- VerificationResult
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VerificationResult/$meta:
get:
tags:
- VerificationResult
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VerificationResult/{id}/$meta:
get:
tags:
- VerificationResult
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VerificationResult/$expunge:
post:
tags:
- VerificationResult
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VerificationResult/{id}/$expunge:
post:
tags:
- VerificationResult
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VisionPrescription/{id}:
get:
tags:
- VisionPrescription
summary: "read-instance: Read VisionPrescription 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:
- VisionPrescription
summary: "update-instance: Update an existing VisionPrescription 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": "VisionPrescription"
}
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:
- VisionPrescription
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:
- VisionPrescription
summary: "instance-patch: Patch a resource instance of type VisionPrescription\
\ 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'
/VisionPrescription/{id}/_history/{version_id}:
get:
tags:
- VisionPrescription
summary: "vread-instance: Read VisionPrescription 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'
/VisionPrescription:
get:
tags:
- VisionPrescription
summary: "search-type: Search for VisionPrescription instances"
description: This is a search type
parameters:
- name: prescriber
in: query
description: Who authorized the vision prescription
style: simple
- name: identifier
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item * [CarePlan](careplan.html): External Ids for\
\ this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html):\
\ Version-independent identifier for the Composition * [Condition](condition.html):\
\ A unique identifier of the condition record * [Consent](consent.html):\
\ Identifier for this record (external references) * [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue * [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order * [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report * [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents * [DocumentReference](documentreference.html):\
\ Identifier of the attachment binary * [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known * [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier * [Goal](goal.html): External Ids for\
\ this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study,\
\ such as DICOM Study Instance UID * [Immunization](immunization.html):\
\ Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier * [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier * [MedicationUsage](medicationusage.html):\
\ Return statements with this external identifier * [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier * [Observation](observation.html):\
\ The unique id for a particular observation * [Procedure](procedure.html):\
\ A unique identifier for a procedure * [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment * [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html):\
\ External identifier * [SupplyRequest](supplyrequest.html): Business Identifier\
\ for SupplyRequest * [VisionPrescription](visionprescription.html): Return\
\ prescriptions with this external identifier "
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: datewritten
in: query
description: Return prescriptions written on this date
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: encounter
in: query
description: "Multiple Resources: * [Composition](composition.html): Context\
\ of the Composition * [DeviceRequest](devicerequest.html): Encounter during\
\ which request was created * [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made * [Flag](flag.html): Alert relevant\
\ during encounter * [List](list.html): Context in which list created *\
\ [NutritionOrder](nutritionorder.html): Return nutrition orders with this\
\ encounter identifier * [Observation](observation.html): Encounter related\
\ to the observation * [Procedure](procedure.html): The Encounter during\
\ which this Procedure was created * [RiskAssessment](riskassessment.html):\
\ Where was assessment performed? * [ServiceRequest](servicerequest.html):\
\ An encounter in which this request is made * [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier "
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: patient
in: query
description: "Multiple Resources: * [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for * [CarePlan](careplan.html): Who the care plan\
\ is for * [CareTeam](careteam.html): Who care team is for * [ClinicalImpression](clinicalimpression.html):\
\ Patient assessed * [Composition](composition.html): Who and/or what the\
\ composition is about * [Condition](condition.html): Who has the condition?\
\ * [Consent](consent.html): Who the consent applies to * [DetectedIssue](detectedissue.html):\
\ Associated patient * [DeviceRequest](devicerequest.html): Individual the\
\ service is ordered for * [DeviceUsage](deviceusage.html): Search by patient\
\ who used / uses the device * [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient * [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents * [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document * [Encounter](encounter.html):\
\ The patient present at the encounter * [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care * [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for * [Flag](flag.html):\
\ The identity of a subject to list flags for * [Goal](goal.html): Who this\
\ goal is intended for * [ImagingStudy](imagingstudy.html): Who the study\
\ is about * [Immunization](immunization.html): The patient for the vaccination\
\ record * [List](list.html): If all resources have the same subject * [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for * [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for * [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient * [MedicationUsage](medicationusage.html):\
\ Returns statements for a specific patient. * [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement * [Observation](observation.html): The subject that the observation\
\ is about (if patient) * [Procedure](procedure.html): Search by subject\
\ - a patient * [RiskAssessment](riskassessment.html): Who/what does assessment\
\ apply to? * [ServiceRequest](servicerequest.html): Search by subject -\
\ a patient * [SupplyDelivery](supplydelivery.html): Patient for whom the\
\ item is supplied * [VisionPrescription](visionprescription.html): The\
\ identity of a patient to list dispenses for "
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: The status of the vision prescription
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- VisionPrescription
summary: "create-type: Create a new VisionPrescription instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "VisionPrescription"
}
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'
/VisionPrescription/_history:
get:
tags:
- VisionPrescription
summary: "type-history: Fetch the resource change history for all resources\
\ of type VisionPrescription"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VisionPrescription/{id}/_history:
get:
tags:
- VisionPrescription
summary: "instance-history: Fetch the resource change history for all resources\
\ of type VisionPrescription"
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'
/VisionPrescription/$validate:
get:
tags:
- VisionPrescription
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VisionPrescription/{id}/$validate:
get:
tags:
- VisionPrescription
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VisionPrescription/{id}/$meta-delete:
post:
tags:
- VisionPrescription
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VisionPrescription/{id}/$meta-add:
post:
tags:
- VisionPrescription
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VisionPrescription/$meta:
get:
tags:
- VisionPrescription
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VisionPrescription/{id}/$meta:
get:
tags:
- VisionPrescription
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VisionPrescription/$expunge:
post:
tags:
- VisionPrescription
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/VisionPrescription/{id}/$expunge:
post:
tags:
- VisionPrescription
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
components:
schemas:
FHIR-JSON-RESOURCE:
type: object
description: A FHIR resource
FHIR-XML-RESOURCE:
type: object
description: A FHIR resource