"
}
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
/DiagnosticReport:
get:
tags:
- DiagnosticReport
summary: "search-type: Search for DiagnosticReport instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ When the event occurred\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ Appointment date/time.\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Time when the event was recorded\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Time period plan covers\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ A date within the coverage time period.\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ When the assessment was documented\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Composition editing time\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ When consent was agreed to\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The clinically relevant time of the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ When this document reference was created\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ A date within the actualPeriod the Encounter lasted\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The provided date search value falls within the episode of care's period\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Time period when flag is active\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Vaccination (non)-Administration Date\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ Date the evaluation was generated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Date recommendation(s) created\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Invoice date / posting date\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ When the list was prepared\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The date of the measure report\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Date when patient was taking (or not taking) the medication\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Clinically relevant time/time-period for observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ When the procedure occurred or is occurring\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Start and end of participation\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ When the request was made\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: study
in: query
description: Studies associated with the diagnostic report
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Event or incident that occurred or was averted\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ More specific code for the event\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Kind of Resource\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ A code that identifies the charge, like a billing code\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Code for the condition\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Issue Type, e.g. drug-drug, duplicate therapy, etc.\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Code for what is being requested/ordered\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a condition code\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ The imaging selection status\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ What the purpose of this list is\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements of this medication code\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements of this code of NutritionIntake\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The code of the observation type\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A code to identify a procedure\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The code of the request orchestration\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by task code\r\n"
required: false
schema:
type: string
- name: subject
in: query
description: The subject of the report
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: media
in: query
description: A reference to the image source.
required: false
schema:
type: string
- name: conclusion
in: query
description: A coded conclusion (interpretation/impression) on the report
required: false
schema:
type: string
- name: result
in: query
description: Link to an atomic result (observation resource)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: based-on
in: query
description: Reference to the service request.
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: specimen
in: query
description: The specimen details
required: false
schema:
type: string
- name: issued
in: query
description: When the report was issued
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: performer
in: query
description: Who is responsible for the report
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Encounter related to the activity recorded in the AuditEvent\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ The Encounter during which this CarePlan was created\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Encounter associated with event\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Encounters associated with a billed line item\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ The Encounter during which this ClinicalImpression was created\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ The Encounter during which this Communication was created\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ The Encounter during which this CommunicationRequest was created\r\n*\
\ [Composition](https://hl7.org/fhir/R5/composition.html): Context of the\
\ Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ The Encounter during which this Condition was created\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Encounter during which request was created\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [EncounterHistory](https://hl7.org/fhir/R5/encounterhistory.html):\
\ The Encounter associated with this set of history values\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ Encounters associated with a billed line item\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Alert relevant during encounter\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ The context of the study\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Context in which list created\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with a specific encounter\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific encounter\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific encounter\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this encounter identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Encounter related to the observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ The Encounter during which this Procedure was created\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Encounter related to the Provenance\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ Encounter associated with the questionnaire response\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The encounter the request orchestration applies to\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Where was assessment performed?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ An encounter in which this request is made\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by encounter\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this encounter identifier\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: category
in: query
description: Which diagnostic discipline/department created the report
required: false
schema:
type: string
- name: results-interpreter
in: query
description: Who was the source of the report
required: false
schema:
type: string
- name: status
in: query
description: The status of the report
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/DiagnosticReport/_search:
get:
tags:
- DiagnosticReport
summary: "search-type: Search for DiagnosticReport instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ When the event occurred\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ Appointment date/time.\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Time when the event was recorded\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Time period plan covers\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ A date within the coverage time period.\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ When the assessment was documented\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Composition editing time\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ When consent was agreed to\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The clinically relevant time of the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ When this document reference was created\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ A date within the actualPeriod the Encounter lasted\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The provided date search value falls within the episode of care's period\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Time period when flag is active\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Vaccination (non)-Administration Date\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ Date the evaluation was generated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Date recommendation(s) created\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Invoice date / posting date\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ When the list was prepared\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The date of the measure report\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Date when patient was taking (or not taking) the medication\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Clinically relevant time/time-period for observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ When the procedure occurred or is occurring\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Start and end of participation\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ When the request was made\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: study
in: query
description: Studies associated with the diagnostic report
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Event or incident that occurred or was averted\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ More specific code for the event\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Kind of Resource\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ A code that identifies the charge, like a billing code\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Code for the condition\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Issue Type, e.g. drug-drug, duplicate therapy, etc.\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Code for what is being requested/ordered\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a condition code\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ The imaging selection status\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ What the purpose of this list is\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements of this medication code\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements of this code of NutritionIntake\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The code of the observation type\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A code to identify a procedure\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The code of the request orchestration\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by task code\r\n"
required: false
schema:
type: string
- name: subject
in: query
description: The subject of the report
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: media
in: query
description: A reference to the image source.
required: false
schema:
type: string
- name: conclusion
in: query
description: A coded conclusion (interpretation/impression) on the report
required: false
schema:
type: string
- name: result
in: query
description: Link to an atomic result (observation resource)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: based-on
in: query
description: Reference to the service request.
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: specimen
in: query
description: The specimen details
required: false
schema:
type: string
- name: issued
in: query
description: When the report was issued
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: performer
in: query
description: Who is responsible for the report
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Encounter related to the activity recorded in the AuditEvent\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ The Encounter during which this CarePlan was created\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Encounter associated with event\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Encounters associated with a billed line item\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ The Encounter during which this ClinicalImpression was created\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ The Encounter during which this Communication was created\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ The Encounter during which this CommunicationRequest was created\r\n*\
\ [Composition](https://hl7.org/fhir/R5/composition.html): Context of the\
\ Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ The Encounter during which this Condition was created\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Encounter during which request was created\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [EncounterHistory](https://hl7.org/fhir/R5/encounterhistory.html):\
\ The Encounter associated with this set of history values\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ Encounters associated with a billed line item\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Alert relevant during encounter\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ The context of the study\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Context in which list created\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with a specific encounter\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific encounter\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific encounter\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this encounter identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Encounter related to the observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ The Encounter during which this Procedure was created\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Encounter related to the Provenance\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ Encounter associated with the questionnaire response\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The encounter the request orchestration applies to\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Where was assessment performed?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ An encounter in which this request is made\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by encounter\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this encounter identifier\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: category
in: query
description: Which diagnostic discipline/department created the report
required: false
schema:
type: string
- name: results-interpreter
in: query
description: Who was the source of the report
required: false
schema:
type: string
- name: status
in: query
description: The status of the report
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/DiagnosticReport/$validate:
get:
tags:
- DiagnosticReport
summary: "GET: /DiagnosticReport/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DiagnosticReport",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/$validate:
get:
tags:
- DiagnosticReport
summary: "GET: /DiagnosticReport/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DiagnosticReport",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/$hapi.fhir.undo-merge:
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/$meta-delete:
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/$meta-add:
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/$meta:
get:
tags:
- DiagnosticReport
summary: "GET: /DiagnosticReport/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/$meta:
get:
tags:
- DiagnosticReport
summary: "GET: /DiagnosticReport/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/$hapi.fhir.merge:
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "DiagnosticReport",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/$expunge:
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/$expunge:
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/$diff:
get:
tags:
- DiagnosticReport
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DiagnosticReport
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/$reindex-dryrun:
get:
tags:
- DiagnosticReport
summary: "GET: /DiagnosticReport/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/$reindex:
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/$graphql:
get:
tags:
- DiagnosticReport
summary: "GET: /DiagnosticReport/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DiagnosticReport
summary: "POST: /DiagnosticReport/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "DocumentReference"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "DocumentReference"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/DocumentReference:
get:
tags:
- DocumentReference
summary: "search-type: Search for DocumentReference instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ When the event occurred\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ Appointment date/time.\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Time when the event was recorded\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Time period plan covers\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ A date within the coverage time period.\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ When the assessment was documented\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Composition editing time\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ When consent was agreed to\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The clinically relevant time of the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ When this document reference was created\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ A date within the actualPeriod the Encounter lasted\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The provided date search value falls within the episode of care's period\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Time period when flag is active\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Vaccination (non)-Administration Date\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ Date the evaluation was generated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Date recommendation(s) created\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Invoice date / posting date\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ When the list was prepared\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The date of the measure report\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Date when patient was taking (or not taking) the medication\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Clinically relevant time/time-period for observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ When the procedure occurred or is occurring\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Start and end of participation\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ When the request was made\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: modality
in: query
description: The modality used
required: false
schema:
type: string
- name: subject
in: query
description: Who/what is the subject of the document
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: description
in: query
description: Human-readable description
required: false
schema:
type: string
- name: language
in: query
description: Human language of the content (BCP-47)
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ E.g. patient, expense, depreciation\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The kind of coverage (health plan, auto, Workers Compensation)\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Type/class - e.g. specialist referral, disease management\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Type of Invoice\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses of a specific type\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ Amino Acid Sequence/ DNA Sequence / RNA Sequence\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The specimen type\r\n"
required: false
schema:
type: string
- name: relation
in: query
description: replaces | transforms | signs | appends
required: false
schema:
type: string
- name: setting
in: query
description: Additional details about where the content was created (e.g.
clinical specialty)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: doc-status
in: query
description: preliminary | final | amended | entered-in-error
required: false
schema:
type: string
- name: based-on
in: query
description: Procedure that caused this media to be created
required: false
schema:
type: string
- name: format-canonical
in: query
description: Profile canonical content rules for the document
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: context
in: query
description: Context of the document content
required: false
schema:
type: string
- name: relationship
in: query
description: Combination of relation and relatesTo
required: false
schema:
type: string
- name: creation
in: query
description: Date attachment was first created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: period
in: query
description: Time of service that is being documented
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: bodysite
in: query
description: The body site studied
required: false
schema:
type: string
- name: event-code
in: query
description: Main clinical acts documented
required: false
schema:
type: string
- name: custodian
in: query
description: Organization which maintains the document
required: false
schema:
type: string
- name: author
in: query
description: Who and/or what authored the document
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: bodysite-reference
in: query
description: The body site studied
required: false
schema:
type: string
- name: format-code
in: query
description: Format code content rules for the document
required: false
schema:
type: string
- name: format-uri
in: query
description: Profile URI content rules for the document
required: false
schema:
type: string
- name: version
in: query
description: The business version identifier
required: false
schema:
type: string
- name: attester
in: query
description: Who attested the document
required: false
schema:
type: string
- name: contenttype
in: query
description: "Mime type of the content, with charset etc."
required: false
schema:
type: string
- name: event-reference
in: query
description: Main clinical acts documented
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: security-label
in: query
description: Document security-tags
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: location
in: query
description: Uri where the data can be found
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: category
in: query
description: Categorization of document
required: false
schema:
type: string
- name: relatesto
in: query
description: Target of the relationship
required: false
schema:
type: string
- name: facility
in: query
description: Kind of facility where patient was seen
required: false
schema:
type: string
- name: status
in: query
description: current | superseded | entered-in-error
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/DocumentReference/_search:
get:
tags:
- DocumentReference
summary: "search-type: Search for DocumentReference instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ When the event occurred\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ Appointment date/time.\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Time when the event was recorded\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Time period plan covers\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ A date within the coverage time period.\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ When the assessment was documented\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Composition editing time\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ When consent was agreed to\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The clinically relevant time of the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ When this document reference was created\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ A date within the actualPeriod the Encounter lasted\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The provided date search value falls within the episode of care's period\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Time period when flag is active\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Vaccination (non)-Administration Date\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ Date the evaluation was generated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Date recommendation(s) created\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Invoice date / posting date\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ When the list was prepared\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The date of the measure report\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Date when patient was taking (or not taking) the medication\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Clinically relevant time/time-period for observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ When the procedure occurred or is occurring\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Start and end of participation\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ When the request was made\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: modality
in: query
description: The modality used
required: false
schema:
type: string
- name: subject
in: query
description: Who/what is the subject of the document
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: description
in: query
description: Human-readable description
required: false
schema:
type: string
- name: language
in: query
description: Human language of the content (BCP-47)
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ E.g. patient, expense, depreciation\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The kind of coverage (health plan, auto, Workers Compensation)\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Type/class - e.g. specialist referral, disease management\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Type of Invoice\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses of a specific type\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ Amino Acid Sequence/ DNA Sequence / RNA Sequence\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The specimen type\r\n"
required: false
schema:
type: string
- name: relation
in: query
description: replaces | transforms | signs | appends
required: false
schema:
type: string
- name: setting
in: query
description: Additional details about where the content was created (e.g.
clinical specialty)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: doc-status
in: query
description: preliminary | final | amended | entered-in-error
required: false
schema:
type: string
- name: based-on
in: query
description: Procedure that caused this media to be created
required: false
schema:
type: string
- name: format-canonical
in: query
description: Profile canonical content rules for the document
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: context
in: query
description: Context of the document content
required: false
schema:
type: string
- name: relationship
in: query
description: Combination of relation and relatesTo
required: false
schema:
type: string
- name: creation
in: query
description: Date attachment was first created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: period
in: query
description: Time of service that is being documented
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: bodysite
in: query
description: The body site studied
required: false
schema:
type: string
- name: event-code
in: query
description: Main clinical acts documented
required: false
schema:
type: string
- name: custodian
in: query
description: Organization which maintains the document
required: false
schema:
type: string
- name: author
in: query
description: Who and/or what authored the document
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: bodysite-reference
in: query
description: The body site studied
required: false
schema:
type: string
- name: format-code
in: query
description: Format code content rules for the document
required: false
schema:
type: string
- name: format-uri
in: query
description: Profile URI content rules for the document
required: false
schema:
type: string
- name: version
in: query
description: The business version identifier
required: false
schema:
type: string
- name: attester
in: query
description: Who attested the document
required: false
schema:
type: string
- name: contenttype
in: query
description: "Mime type of the content, with charset etc."
required: false
schema:
type: string
- name: event-reference
in: query
description: Main clinical acts documented
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: security-label
in: query
description: Document security-tags
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: location
in: query
description: Uri where the data can be found
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: category
in: query
description: Categorization of document
required: false
schema:
type: string
- name: relatesto
in: query
description: Target of the relationship
required: false
schema:
type: string
- name: facility
in: query
description: Kind of facility where patient was seen
required: false
schema:
type: string
- name: status
in: query
description: current | superseded | entered-in-error
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/DocumentReference/$validate:
get:
tags:
- DocumentReference
summary: "GET: /DocumentReference/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DocumentReference",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/$validate:
get:
tags:
- DocumentReference
summary: "GET: /DocumentReference/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DocumentReference",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/$hapi.fhir.undo-merge:
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/$meta-delete:
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/$meta-add:
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/$meta:
get:
tags:
- DocumentReference
summary: "GET: /DocumentReference/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/$meta:
get:
tags:
- DocumentReference
summary: "GET: /DocumentReference/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/$hapi.fhir.merge:
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "DocumentReference",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/$expunge:
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/$expunge:
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/$diff:
get:
tags:
- DocumentReference
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DocumentReference
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/$reindex-dryrun:
get:
tags:
- DocumentReference
summary: "GET: /DocumentReference/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/$reindex:
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/$graphql:
get:
tags:
- DocumentReference
summary: "GET: /DocumentReference/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DocumentReference
summary: "POST: /DocumentReference/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "Encounter"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Encounter"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/Encounter:
get:
tags:
- Encounter
summary: "search-type: Search for Encounter instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ When the event occurred\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ Appointment date/time.\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Time when the event was recorded\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Time period plan covers\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ A date within the coverage time period.\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ When the assessment was documented\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Composition editing time\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ When consent was agreed to\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The clinically relevant time of the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ When this document reference was created\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ A date within the actualPeriod the Encounter lasted\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The provided date search value falls within the episode of care's period\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Time period when flag is active\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Vaccination (non)-Administration Date\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ Date the evaluation was generated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Date recommendation(s) created\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Invoice date / posting date\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ When the list was prepared\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The date of the measure report\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Date when patient was taking (or not taking) the medication\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Clinically relevant time/time-period for observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ When the procedure occurred or is occurring\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Start and end of participation\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ When the request was made\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: participant-type
in: query
description: Role of participant in encounter
required: false
schema:
type: string
- name: subject-status
in: query
description: The current status of the subject in relation to the Encounter
required: false
schema:
type: string
- name: subject
in: query
description: The patient or group present at the encounter
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: appointment
in: query
description: The appointment that scheduled this encounter
required: false
schema:
type: string
- name: part-of
in: query
description: Another Encounter this encounter is part of
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ E.g. patient, expense, depreciation\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The kind of coverage (health plan, auto, Workers Compensation)\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Type/class - e.g. specialist referral, disease management\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Type of Invoice\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses of a specific type\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ Amino Acid Sequence/ DNA Sequence / RNA Sequence\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The specimen type\r\n"
required: false
schema:
type: string
- name: participant
in: query
description: Persons involved in the encounter other than the patient
required: false
schema:
type: string
- name: reason-code
in: query
description: Reference to a concept (coded)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: based-on
in: query
description: The ServiceRequest that initiated this encounter
required: false
schema:
type: string
- name: date-start
in: query
description: The actual start date of the Encounter
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: location-period
in: query
description: Time period during which the patient was present at the location
required: false
schema:
type: string
- name: special-arrangement
in: query
description: "Wheelchair, translator, stretcher, etc."
required: false
schema:
type: string
- name: class
in: query
description: Classification of patient encounter
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: diagnosis-code
in: query
description: The diagnosis or procedure relevant to the encounter (coded)
required: false
schema:
type: string
- name: practitioner
in: query
description: Persons involved in the encounter other than the patient
required: false
schema:
type: string
- name: episode-of-care
in: query
description: Episode(s) of care that this encounter should be recorded against
required: false
schema:
type: string
- name: length
in: query
description: Length of encounter in days
required: false
schema:
anyOf:
- type: string
- type: number
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: careteam
in: query
description: Careteam allocated to participate in the encounter
required: false
schema:
type: string
- name: end-date
in: query
description: The actual end date of the Encounter
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: diagnosis-reference
in: query
description: The diagnosis or procedure relevant to the encounter (resource
reference)
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: reason-reference
in: query
description: Reference to a resource (resource reference)
required: false
schema:
type: string
- name: location
in: query
description: Location the encounter takes place
required: false
schema:
type: string
- name: service-provider
in: query
description: The organization (facility) responsible for this encounter
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: account
in: query
description: The set of accounts that may be used for billing for this Encounter
required: false
schema:
type: string
- name: status
in: query
description: planned | in-progress | on-hold | completed | cancelled | entered-in-error
| unknown
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/Encounter/_search:
get:
tags:
- Encounter
summary: "search-type: Search for Encounter instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ When the event occurred\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ Appointment date/time.\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Time when the event was recorded\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Time period plan covers\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ A date within the coverage time period.\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ When the assessment was documented\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Composition editing time\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ When consent was agreed to\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The clinically relevant time of the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ When this document reference was created\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ A date within the actualPeriod the Encounter lasted\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The provided date search value falls within the episode of care's period\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Time period when flag is active\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Vaccination (non)-Administration Date\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ Date the evaluation was generated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Date recommendation(s) created\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Invoice date / posting date\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ When the list was prepared\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The date of the measure report\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Date when patient was taking (or not taking) the medication\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Clinically relevant time/time-period for observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ When the procedure occurred or is occurring\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Start and end of participation\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ When the request was made\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: participant-type
in: query
description: Role of participant in encounter
required: false
schema:
type: string
- name: subject-status
in: query
description: The current status of the subject in relation to the Encounter
required: false
schema:
type: string
- name: subject
in: query
description: The patient or group present at the encounter
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: appointment
in: query
description: The appointment that scheduled this encounter
required: false
schema:
type: string
- name: part-of
in: query
description: Another Encounter this encounter is part of
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ E.g. patient, expense, depreciation\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The kind of coverage (health plan, auto, Workers Compensation)\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Type/class - e.g. specialist referral, disease management\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Type of Invoice\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses of a specific type\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ Amino Acid Sequence/ DNA Sequence / RNA Sequence\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The specimen type\r\n"
required: false
schema:
type: string
- name: participant
in: query
description: Persons involved in the encounter other than the patient
required: false
schema:
type: string
- name: reason-code
in: query
description: Reference to a concept (coded)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: based-on
in: query
description: The ServiceRequest that initiated this encounter
required: false
schema:
type: string
- name: date-start
in: query
description: The actual start date of the Encounter
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: location-period
in: query
description: Time period during which the patient was present at the location
required: false
schema:
type: string
- name: special-arrangement
in: query
description: "Wheelchair, translator, stretcher, etc."
required: false
schema:
type: string
- name: class
in: query
description: Classification of patient encounter
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: diagnosis-code
in: query
description: The diagnosis or procedure relevant to the encounter (coded)
required: false
schema:
type: string
- name: practitioner
in: query
description: Persons involved in the encounter other than the patient
required: false
schema:
type: string
- name: episode-of-care
in: query
description: Episode(s) of care that this encounter should be recorded against
required: false
schema:
type: string
- name: length
in: query
description: Length of encounter in days
required: false
schema:
anyOf:
- type: string
- type: number
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: careteam
in: query
description: Careteam allocated to participate in the encounter
required: false
schema:
type: string
- name: end-date
in: query
description: The actual end date of the Encounter
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: diagnosis-reference
in: query
description: The diagnosis or procedure relevant to the encounter (resource
reference)
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: reason-reference
in: query
description: Reference to a resource (resource reference)
required: false
schema:
type: string
- name: location
in: query
description: Location the encounter takes place
required: false
schema:
type: string
- name: service-provider
in: query
description: The organization (facility) responsible for this encounter
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: account
in: query
description: The set of accounts that may be used for billing for this Encounter
required: false
schema:
type: string
- name: status
in: query
description: planned | in-progress | on-hold | completed | cancelled | entered-in-error
| unknown
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/Encounter/$validate:
get:
tags:
- Encounter
summary: "GET: /Encounter/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Encounter
summary: "POST: /Encounter/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Encounter",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$validate:
get:
tags:
- Encounter
summary: "GET: /Encounter/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Encounter
summary: "POST: /Encounter/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Encounter",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/$hapi.fhir.undo-merge:
post:
tags:
- Encounter
summary: "POST: /Encounter/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$meta-delete:
post:
tags:
- Encounter
summary: "POST: /Encounter/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$meta-add:
post:
tags:
- Encounter
summary: "POST: /Encounter/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/$meta:
get:
tags:
- Encounter
summary: "GET: /Encounter/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Encounter
summary: "POST: /Encounter/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$meta:
get:
tags:
- Encounter
summary: "GET: /Encounter/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Encounter
summary: "POST: /Encounter/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/$hapi.fhir.merge:
post:
tags:
- Encounter
summary: "POST: /Encounter/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "Encounter",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/$expunge:
post:
tags:
- Encounter
summary: "POST: /Encounter/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$expunge:
post:
tags:
- Encounter
summary: "POST: /Encounter/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/$everything:
get:
tags:
- Encounter
summary: "GET: /Encounter/$everything"
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
schema:
type: string
- 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
schema:
type: string
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by
the given range
required: false
schema:
type: string
- 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
schema:
type: string
- 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
schema:
type: string
- 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
schema:
type: string
- name: _type
in: query
description: "Filter the resources to return only resources matching the given\
\ _type filter. When _type is specified, only resources of the listed types\
\ are returned; the patient anchor resource itself is also subject to this\
\ filter and is omitted unless Patient is included in _type."
required: false
schema:
type: string
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
required: false
schema:
type: string
- name: _mdm
in: query
description: "If set to true, expands the patient set to include all patients\
\ linked via MDM before returning results. Requires MDM to be enabled on\
\ the server."
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Encounter
summary: "POST: /Encounter/$everything"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_count"
}, {
"name": "_offset"
}, {
"name": "_lastUpdated"
}, {
"name": "_content",
"valueString": "example"
}, {
"name": "_text",
"valueString": "example"
}, {
"name": "_filter",
"valueString": "example"
}, {
"name": "_type",
"valueString": "example"
}, {
"name": "_id"
}, {
"name": "_mdm",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$everything:
get:
tags:
- Encounter
summary: "GET: /Encounter/{id}/$everything"
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
schema:
type: string
- 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
schema:
type: string
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by
the given range
required: false
schema:
type: string
- 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
schema:
type: string
- 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
schema:
type: string
- 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
schema:
type: string
- name: _type
in: query
description: "Filter the resources to return only resources matching the given\
\ _type filter. When _type is specified, only resources of the listed types\
\ are returned; the patient anchor resource itself is also subject to this\
\ filter and is omitted unless Patient is included in _type."
required: false
schema:
type: string
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
required: false
schema:
type: string
- name: _mdm
in: query
description: "If set to true, expands the patient set to include all patients\
\ linked via MDM before returning results. Requires MDM to be enabled on\
\ the server."
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Encounter
summary: "POST: /Encounter/{id}/$everything"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_count"
}, {
"name": "_offset"
}, {
"name": "_lastUpdated"
}, {
"name": "_content",
"valueString": "example"
}, {
"name": "_text",
"valueString": "example"
}, {
"name": "_filter",
"valueString": "example"
}, {
"name": "_type",
"valueString": "example"
}, {
"name": "_id"
}, {
"name": "_mdm",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$diff:
get:
tags:
- Encounter
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Encounter
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$reindex-dryrun:
get:
tags:
- Encounter
summary: "GET: /Encounter/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Encounter
summary: "POST: /Encounter/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$reindex:
post:
tags:
- Encounter
summary: "POST: /Encounter/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/$graphql:
get:
tags:
- Encounter
summary: "GET: /Encounter/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Encounter
summary: "POST: /Encounter/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}:
get:
tags:
- EncounterHistory
summary: "read-instance: Read EncounterHistory instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EncounterHistory"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
put:
tags:
- EncounterHistory
summary: "update-instance: Update an existing EncounterHistory 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": "EncounterHistory"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- EncounterHistory
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:
- EncounterHistory
summary: "instance-patch: Patch a resource instance of type EncounterHistory\
\ 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"
/EncounterHistory/{id}/_history/{version_id}:
get:
tags:
- EncounterHistory
summary: "vread-instance: Read EncounterHistory 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"
example: |-
{
"resourceType": "EncounterHistory"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EncounterHistory:
get:
tags:
- EncounterHistory
summary: "search-type: Search for EncounterHistory instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: Identifier(s) by which this encounter is known
required: false
schema:
type: string
- name: subject
in: query
description: The patient or group present at the encounter
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Encounter related to the activity recorded in the AuditEvent\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ The Encounter during which this CarePlan was created\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Encounter associated with event\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Encounters associated with a billed line item\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ The Encounter during which this ClinicalImpression was created\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ The Encounter during which this Communication was created\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ The Encounter during which this CommunicationRequest was created\r\n*\
\ [Composition](https://hl7.org/fhir/R5/composition.html): Context of the\
\ Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ The Encounter during which this Condition was created\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Encounter during which request was created\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [EncounterHistory](https://hl7.org/fhir/R5/encounterhistory.html):\
\ The Encounter associated with this set of history values\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ Encounters associated with a billed line item\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Alert relevant during encounter\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ The context of the study\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Context in which list created\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with a specific encounter\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific encounter\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific encounter\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this encounter identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Encounter related to the observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ The Encounter during which this Procedure was created\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Encounter related to the Provenance\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ Encounter associated with the questionnaire response\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The encounter the request orchestration applies to\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Where was assessment performed?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ An encounter in which this request is made\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by encounter\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this encounter identifier\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: patient
in: query
description: The patient present at the encounter
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: Status of the Encounter history entry
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
post:
tags:
- EncounterHistory
summary: "create-type: Create a new EncounterHistory instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EncounterHistory"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/_history:
get:
tags:
- EncounterHistory
summary: "type-history: Fetch the resource change history for all resources\
\ of type EncounterHistory"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EncounterHistory/{id}/_history:
get:
tags:
- EncounterHistory
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EncounterHistory"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EncounterHistory/_search:
get:
tags:
- EncounterHistory
summary: "search-type: Search for EncounterHistory instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: Identifier(s) by which this encounter is known
required: false
schema:
type: string
- name: subject
in: query
description: The patient or group present at the encounter
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Encounter related to the activity recorded in the AuditEvent\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ The Encounter during which this CarePlan was created\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Encounter associated with event\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Encounters associated with a billed line item\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ The Encounter during which this ClinicalImpression was created\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ The Encounter during which this Communication was created\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ The Encounter during which this CommunicationRequest was created\r\n*\
\ [Composition](https://hl7.org/fhir/R5/composition.html): Context of the\
\ Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ The Encounter during which this Condition was created\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Encounter during which request was created\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [EncounterHistory](https://hl7.org/fhir/R5/encounterhistory.html):\
\ The Encounter associated with this set of history values\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ Encounters associated with a billed line item\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Alert relevant during encounter\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ The context of the study\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Context in which list created\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with a specific encounter\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific encounter\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific encounter\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this encounter identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Encounter related to the observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ The Encounter during which this Procedure was created\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Encounter related to the Provenance\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ Encounter associated with the questionnaire response\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The encounter the request orchestration applies to\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Where was assessment performed?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ An encounter in which this request is made\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by encounter\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this encounter identifier\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: patient
in: query
description: The patient present at the encounter
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: Status of the Encounter history entry
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EncounterHistory/$validate:
get:
tags:
- EncounterHistory
summary: "GET: /EncounterHistory/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource"
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}/$validate:
get:
tags:
- EncounterHistory
summary: "GET: /EncounterHistory/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource"
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/$hapi.fhir.undo-merge:
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}/$meta-delete:
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}/$meta-add:
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/$meta:
get:
tags:
- EncounterHistory
summary: "GET: /EncounterHistory/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}/$meta:
get:
tags:
- EncounterHistory
summary: "GET: /EncounterHistory/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/$hapi.fhir.merge:
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource"
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/$expunge:
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}/$expunge:
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}/$diff:
get:
tags:
- EncounterHistory
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EncounterHistory
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}/$reindex-dryrun:
get:
tags:
- EncounterHistory
summary: "GET: /EncounterHistory/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}/$reindex:
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EncounterHistory/{id}/$graphql:
get:
tags:
- EncounterHistory
summary: "GET: /EncounterHistory/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EncounterHistory
summary: "POST: /EncounterHistory/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "Endpoint"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Endpoint"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/Endpoint:
get:
tags:
- Endpoint
summary: "search-type: Search for Endpoint instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: Identifies this endpoint across multiple systems
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: payload-type
in: query
description: The type of content that may be used at this endpoint (e.g. XDS
Discharge summaries)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: connection-type
in: query
description: Protocol/Profile/Standard to be used with this endpoint connection
required: false
schema:
type: string
- name: organization
in: query
description: The organization that is managing the endpoint
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: A name that this endpoint can be identified by
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The current status of the Endpoint (usually expected to be active)
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/Endpoint/_search:
get:
tags:
- Endpoint
summary: "search-type: Search for Endpoint instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: Identifies this endpoint across multiple systems
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: payload-type
in: query
description: The type of content that may be used at this endpoint (e.g. XDS
Discharge summaries)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: connection-type
in: query
description: Protocol/Profile/Standard to be used with this endpoint connection
required: false
schema:
type: string
- name: organization
in: query
description: The organization that is managing the endpoint
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: A name that this endpoint can be identified by
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The current status of the Endpoint (usually expected to be active)
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/Endpoint/$validate:
get:
tags:
- Endpoint
summary: "GET: /Endpoint/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Endpoint
summary: "POST: /Endpoint/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Endpoint",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/$validate:
get:
tags:
- Endpoint
summary: "GET: /Endpoint/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Endpoint
summary: "POST: /Endpoint/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Endpoint",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/$hapi.fhir.undo-merge:
post:
tags:
- Endpoint
summary: "POST: /Endpoint/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/$meta-delete:
post:
tags:
- Endpoint
summary: "POST: /Endpoint/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/$meta-add:
post:
tags:
- Endpoint
summary: "POST: /Endpoint/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/$meta:
get:
tags:
- Endpoint
summary: "GET: /Endpoint/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Endpoint
summary: "POST: /Endpoint/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/$meta:
get:
tags:
- Endpoint
summary: "GET: /Endpoint/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Endpoint
summary: "POST: /Endpoint/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/$hapi.fhir.merge:
post:
tags:
- Endpoint
summary: "POST: /Endpoint/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "Endpoint",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/$expunge:
post:
tags:
- Endpoint
summary: "POST: /Endpoint/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/$expunge:
post:
tags:
- Endpoint
summary: "POST: /Endpoint/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/$diff:
get:
tags:
- Endpoint
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Endpoint
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/$reindex-dryrun:
get:
tags:
- Endpoint
summary: "GET: /Endpoint/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Endpoint
summary: "POST: /Endpoint/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/$reindex:
post:
tags:
- Endpoint
summary: "POST: /Endpoint/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/$graphql:
get:
tags:
- Endpoint
summary: "GET: /Endpoint/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Endpoint
summary: "POST: /Endpoint/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "EnrollmentRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "EnrollmentRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EnrollmentRequest:
get:
tags:
- EnrollmentRequest
summary: "search-type: Search for EnrollmentRequest instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: subject
in: query
description: The party to be enrolled
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The status of the enrollment
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EnrollmentRequest/_search:
get:
tags:
- EnrollmentRequest
summary: "search-type: Search for EnrollmentRequest instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: subject
in: query
description: The party to be enrolled
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The status of the enrollment
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EnrollmentRequest/$validate:
get:
tags:
- EnrollmentRequest
summary: "GET: /EnrollmentRequest/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EnrollmentRequest",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/$validate:
get:
tags:
- EnrollmentRequest
summary: "GET: /EnrollmentRequest/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EnrollmentRequest",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/$hapi.fhir.undo-merge:
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/$meta-delete:
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/$meta-add:
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/$meta:
get:
tags:
- EnrollmentRequest
summary: "GET: /EnrollmentRequest/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/$meta:
get:
tags:
- EnrollmentRequest
summary: "GET: /EnrollmentRequest/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/$hapi.fhir.merge:
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "EnrollmentRequest",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/$expunge:
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/$expunge:
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/$diff:
get:
tags:
- EnrollmentRequest
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentRequest
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/$reindex-dryrun:
get:
tags:
- EnrollmentRequest
summary: "GET: /EnrollmentRequest/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/$reindex:
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/$graphql:
get:
tags:
- EnrollmentRequest
summary: "GET: /EnrollmentRequest/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentRequest
summary: "POST: /EnrollmentRequest/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "EnrollmentResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "EnrollmentResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EnrollmentResponse:
get:
tags:
- EnrollmentResponse
summary: "search-type: Search for EnrollmentResponse instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: The business identifier of the EnrollmentResponse
required: false
schema:
type: string
- name: request
in: query
description: The reference to the claim
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The status of the enrollment response
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EnrollmentResponse/_search:
get:
tags:
- EnrollmentResponse
summary: "search-type: Search for EnrollmentResponse instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: The business identifier of the EnrollmentResponse
required: false
schema:
type: string
- name: request
in: query
description: The reference to the claim
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The status of the enrollment response
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EnrollmentResponse/$validate:
get:
tags:
- EnrollmentResponse
summary: "GET: /EnrollmentResponse/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EnrollmentResponse",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/$validate:
get:
tags:
- EnrollmentResponse
summary: "GET: /EnrollmentResponse/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EnrollmentResponse",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/$hapi.fhir.undo-merge:
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/$meta-delete:
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/$meta-add:
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/$meta:
get:
tags:
- EnrollmentResponse
summary: "GET: /EnrollmentResponse/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/$meta:
get:
tags:
- EnrollmentResponse
summary: "GET: /EnrollmentResponse/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/$hapi.fhir.merge:
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "EnrollmentResponse",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/$expunge:
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/$expunge:
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/$diff:
get:
tags:
- EnrollmentResponse
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentResponse
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/$reindex-dryrun:
get:
tags:
- EnrollmentResponse
summary: "GET: /EnrollmentResponse/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/$reindex:
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/$graphql:
get:
tags:
- EnrollmentResponse
summary: "GET: /EnrollmentResponse/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentResponse
summary: "POST: /EnrollmentResponse/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "EpisodeOfCare"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "EpisodeOfCare"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EpisodeOfCare:
get:
tags:
- EpisodeOfCare
summary: "search-type: Search for EpisodeOfCare instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ When the event occurred\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ Appointment date/time.\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Time when the event was recorded\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Time period plan covers\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ A date within the coverage time period.\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ When the assessment was documented\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Composition editing time\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ When consent was agreed to\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The clinically relevant time of the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ When this document reference was created\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ A date within the actualPeriod the Encounter lasted\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The provided date search value falls within the episode of care's period\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Time period when flag is active\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Vaccination (non)-Administration Date\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ Date the evaluation was generated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Date recommendation(s) created\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Invoice date / posting date\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ When the list was prepared\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The date of the measure report\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Date when patient was taking (or not taking) the medication\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Clinically relevant time/time-period for observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ When the procedure occurred or is occurring\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Start and end of participation\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ When the request was made\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: diagnosis-code
in: query
description: Conditions/problems/diagnoses this episode of care is for (coded)
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ E.g. patient, expense, depreciation\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The kind of coverage (health plan, auto, Workers Compensation)\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Type/class - e.g. specialist referral, disease management\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Type of Invoice\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses of a specific type\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ Amino Acid Sequence/ DNA Sequence / RNA Sequence\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The specimen type\r\n"
required: false
schema:
type: string
- name: reason-code
in: query
description: Reference to a concept (coded)
required: false
schema:
type: string
- name: incoming-referral
in: query
description: Incoming Referral Request
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: diagnosis-reference
in: query
description: Conditions/problems/diagnoses this episode of care is for (resource
reference)
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: organization
in: query
description: The organization that has assumed the specific responsibilities
of this EpisodeOfCare
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: reason-reference
in: query
description: Reference to a resource (resource reference)
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: care-manager
in: query
description: Care manager/care coordinator for the patient
required: false
schema:
type: string
- name: status
in: query
description: The current status of the Episode of Care as provided (does not
check the status history collection)
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EpisodeOfCare/_search:
get:
tags:
- EpisodeOfCare
summary: "search-type: Search for EpisodeOfCare instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ When the event occurred\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ Appointment date/time.\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Time when the event was recorded\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Time period plan covers\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ A date within the coverage time period.\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ When the assessment was documented\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Composition editing time\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ When consent was agreed to\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The clinically relevant time of the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ When this document reference was created\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ A date within the actualPeriod the Encounter lasted\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The provided date search value falls within the episode of care's period\r\
\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Time period when flag is active\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Vaccination (non)-Administration Date\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ Date the evaluation was generated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Date recommendation(s) created\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Invoice date / posting date\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ When the list was prepared\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The date of the measure report\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Date when patient was taking (or not taking) the medication\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ Clinically relevant time/time-period for observation\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ When the procedure occurred or is occurring\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Start and end of participation\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ When the request was made\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ Account number\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Business identifier for the event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ External ids for this item\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ An Identifier of the Appointment\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ An Identifier in this appointment response\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Business identifier\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Bodystructure identifier\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ External Ids for this plan\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ External Ids for this team\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Business Identifier for item\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ The primary identifier of the financial resource\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The identity of the ClaimResponse\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Business identifier\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Unique identifier\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Unique identifier\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Version-independent identifier for the Composition\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ A unique identifier of the condition record\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Identifier for this record (external references)\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the contract\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The primary identifier of the insured and the coverage\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The business identifier of the Eligibility\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The business identifier\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Business identifier for request/order\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by identifier\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Identifier of the attachment binary\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Identifier(s) by which this encounter is known\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The business identifier of the Enrollment\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The business identifier of the Explanation of Benefit\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ A search by a record identifier\r\n* [Flag](https://hl7.org/fhir/R5/flag.html):\
\ Business identifier\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): External\
\ Ids for this goal\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identifier of the guidance response\r\n* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html):\
\ Identifiers for the imaging selection\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Identifiers for the Study, such as DICOM Study Instance UID\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ Business identifier\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ ID of the evaluation\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Business identifier\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Business Identifier for item\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ Business identifier\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ External identifier of the measure report to be returned\r\n* [Medication](https://hl7.org/fhir/R5/medication.html):\
\ Returns medications with this external identifier\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Return statements with this external identifier\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The unique identity for a particular sequence\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The unique id for a particular observation\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ A person Identifier\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ A unique identifier for a procedure\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The unique identifier for the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ An Identifier of the RelatedPerson\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ External identifiers for the request orchestration\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Business Identifier for research subject in a study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Identifiers assigned to this order\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The unique identifier associated with the specimen\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ Business Identifier for SupplyRequest\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search for a task instance by its business identifier\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ Return prescriptions with this external identifier\r\n"
required: false
schema:
type: string
- name: diagnosis-code
in: query
description: Conditions/problems/diagnoses this episode of care is for (coded)
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ E.g. patient, expense, depreciation\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ The kind of coverage (health plan, auto, Workers Compensation)\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ Type/class - e.g. specialist referral, disease management\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Type of Invoice\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ Returns dispenses of a specific type\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ Amino Acid Sequence/ DNA Sequence / RNA Sequence\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The specimen type\r\n"
required: false
schema:
type: string
- name: reason-code
in: query
description: Reference to a concept (coded)
required: false
schema:
type: string
- name: incoming-referral
in: query
description: Incoming Referral Request
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: diagnosis-reference
in: query
description: Conditions/problems/diagnoses this episode of care is for (resource
reference)
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [Account](https://hl7.org/fhir/R5/account.html):\
\ The entity that caused the expenses\r\n* [AdverseEvent](https://hl7.org/fhir/R5/adverseevent.html):\
\ Subject impacted by event\r\n* [AllergyIntolerance](https://hl7.org/fhir/R5/allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [Appointment](https://hl7.org/fhir/R5/appointment.html):\
\ One of the individuals of the appointment is this patient\r\n* [AppointmentResponse](https://hl7.org/fhir/R5/appointmentresponse.html):\
\ This Response is for this Patient\r\n* [AuditEvent](https://hl7.org/fhir/R5/auditevent.html):\
\ Where the activity involved patient data\r\n* [Basic](https://hl7.org/fhir/R5/basic.html):\
\ Identifies the focus of this resource\r\n* [BodyStructure](https://hl7.org/fhir/R5/bodystructure.html):\
\ Who this is about\r\n* [CarePlan](https://hl7.org/fhir/R5/careplan.html):\
\ Who the care plan is for\r\n* [CareTeam](https://hl7.org/fhir/R5/careteam.html):\
\ Who care team is for\r\n* [ChargeItem](https://hl7.org/fhir/R5/chargeitem.html):\
\ Individual service was done for/to\r\n* [Claim](https://hl7.org/fhir/R5/claim.html):\
\ Patient receiving the products or services\r\n* [ClaimResponse](https://hl7.org/fhir/R5/claimresponse.html):\
\ The subject of care\r\n* [ClinicalImpression](https://hl7.org/fhir/R5/clinicalimpression.html):\
\ Patient assessed\r\n* [Communication](https://hl7.org/fhir/R5/communication.html):\
\ Focus of message\r\n* [CommunicationRequest](https://hl7.org/fhir/R5/communicationrequest.html):\
\ Focus of message\r\n* [Composition](https://hl7.org/fhir/R5/composition.html):\
\ Who and/or what the composition is about\r\n* [Condition](https://hl7.org/fhir/R5/condition.html):\
\ Who has the condition?\r\n* [Consent](https://hl7.org/fhir/R5/consent.html):\
\ Who the consent applies to\r\n* [Contract](https://hl7.org/fhir/R5/contract.html):\
\ The identity of the subject of the contract (if a patient)\r\n* [Coverage](https://hl7.org/fhir/R5/coverage.html):\
\ Retrieve coverages for a patient\r\n* [CoverageEligibilityRequest](https://hl7.org/fhir/R5/coverageeligibilityrequest.html):\
\ The reference to the patient\r\n* [CoverageEligibilityResponse](https://hl7.org/fhir/R5/coverageeligibilityresponse.html):\
\ The reference to the patient\r\n* [DetectedIssue](https://hl7.org/fhir/R5/detectedissue.html):\
\ Associated patient\r\n* [DeviceRequest](https://hl7.org/fhir/R5/devicerequest.html):\
\ Individual the service is ordered for\r\n* [DeviceUsage](https://hl7.org/fhir/R5/deviceusage.html):\
\ Search by patient who used / uses the device\r\n* [DiagnosticReport](https://hl7.org/fhir/R5/diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentReference](https://hl7.org/fhir/R5/documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](https://hl7.org/fhir/R5/encounter.html):\
\ The patient present at the encounter\r\n* [EnrollmentRequest](https://hl7.org/fhir/R5/enrollmentrequest.html):\
\ The party to be enrolled\r\n* [EpisodeOfCare](https://hl7.org/fhir/R5/episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [ExplanationOfBenefit](https://hl7.org/fhir/R5/explanationofbenefit.html):\
\ The reference to the patient\r\n* [FamilyMemberHistory](https://hl7.org/fhir/R5/familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](https://hl7.org/fhir/R5/flag.html): The identity of a subject to\
\ list flags for\r\n* [Goal](https://hl7.org/fhir/R5/goal.html): Who this\
\ goal is intended for\r\n* [GuidanceResponse](https://hl7.org/fhir/R5/guidanceresponse.html):\
\ The identity of a patient to search for guidance response results\r\n\
* [ImagingSelection](https://hl7.org/fhir/R5/imagingselection.html): Who\
\ the study is about\r\n* [ImagingStudy](https://hl7.org/fhir/R5/imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](https://hl7.org/fhir/R5/immunization.html):\
\ The patient for the vaccination record\r\n* [ImmunizationEvaluation](https://hl7.org/fhir/R5/immunizationevaluation.html):\
\ The patient being evaluated\r\n* [ImmunizationRecommendation](https://hl7.org/fhir/R5/immunizationrecommendation.html):\
\ Who this profile is for\r\n* [Invoice](https://hl7.org/fhir/R5/invoice.html):\
\ Recipient(s) of goods and services\r\n* [List](https://hl7.org/fhir/R5/list.html):\
\ If all resources have the same subject\r\n* [MeasureReport](https://hl7.org/fhir/R5/measurereport.html):\
\ The identity of a patient to search for individual measure report results\
\ for\r\n* [MedicationAdministration](https://hl7.org/fhir/R5/medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](https://hl7.org/fhir/R5/medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](https://hl7.org/fhir/R5/medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](https://hl7.org/fhir/R5/medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [MolecularSequence](https://hl7.org/fhir/R5/molecularsequence.html):\
\ The subject that the sequence is about\r\n* [NutritionIntake](https://hl7.org/fhir/R5/nutritionintake.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](https://hl7.org/fhir/R5/nutritionorder.html):\
\ The identity of the individual or set of individuals who requires the\
\ diet, formula or nutritional supplement\r\n* [Observation](https://hl7.org/fhir/R5/observation.html):\
\ The subject that the observation is about (if patient)\r\n* [Person](https://hl7.org/fhir/R5/person.html):\
\ The Person links to this Patient\r\n* [Procedure](https://hl7.org/fhir/R5/procedure.html):\
\ Search by subject - a patient\r\n* [Provenance](https://hl7.org/fhir/R5/provenance.html):\
\ Where the activity involved patient data\r\n* [QuestionnaireResponse](https://hl7.org/fhir/R5/questionnaireresponse.html):\
\ The patient that is the subject of the questionnaire response\r\n* [RelatedPerson](https://hl7.org/fhir/R5/relatedperson.html):\
\ The patient this related person is related to\r\n* [RequestOrchestration](https://hl7.org/fhir/R5/requestorchestration.html):\
\ The identity of a patient to search for request orchestrations\r\n* [ResearchSubject](https://hl7.org/fhir/R5/researchsubject.html):\
\ Who or what is part of study\r\n* [RiskAssessment](https://hl7.org/fhir/R5/riskassessment.html):\
\ Who/what does assessment apply to?\r\n* [ServiceRequest](https://hl7.org/fhir/R5/servicerequest.html):\
\ Search by subject - a patient\r\n* [Specimen](https://hl7.org/fhir/R5/specimen.html):\
\ The patient the specimen comes from\r\n* [SupplyDelivery](https://hl7.org/fhir/R5/supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [SupplyRequest](https://hl7.org/fhir/R5/supplyrequest.html):\
\ The patient or subject for whom the supply is destined\r\n* [Task](https://hl7.org/fhir/R5/task.html):\
\ Search by patient\r\n* [VisionPrescription](https://hl7.org/fhir/R5/visionprescription.html):\
\ The identity of a patient to list dispenses for\r\n"
required: false
schema:
type: string
- name: organization
in: query
description: The organization that has assumed the specific responsibilities
of this EpisodeOfCare
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: reason-reference
in: query
description: Reference to a resource (resource reference)
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: care-manager
in: query
description: Care manager/care coordinator for the patient
required: false
schema:
type: string
- name: status
in: query
description: The current status of the Episode of Care as provided (does not
check the status history collection)
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EpisodeOfCare/$validate:
get:
tags:
- EpisodeOfCare
summary: "GET: /EpisodeOfCare/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EpisodeOfCare",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/$validate:
get:
tags:
- EpisodeOfCare
summary: "GET: /EpisodeOfCare/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EpisodeOfCare",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/$hapi.fhir.undo-merge:
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/$meta-delete:
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/$meta-add:
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/$meta:
get:
tags:
- EpisodeOfCare
summary: "GET: /EpisodeOfCare/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/$meta:
get:
tags:
- EpisodeOfCare
summary: "GET: /EpisodeOfCare/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/$hapi.fhir.merge:
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "EpisodeOfCare",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/$expunge:
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/$expunge:
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/$diff:
get:
tags:
- EpisodeOfCare
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EpisodeOfCare
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/$reindex-dryrun:
get:
tags:
- EpisodeOfCare
summary: "GET: /EpisodeOfCare/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/$reindex:
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/$graphql:
get:
tags:
- EpisodeOfCare
summary: "GET: /EpisodeOfCare/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EpisodeOfCare
summary: "POST: /EpisodeOfCare/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "EventDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "EventDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EventDefinition:
get:
tags:
- EventDefinition
summary: "search-type: Search for EventDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The activity definition publication date\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The Actor Definition publication date\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The capability statement publication date\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The charge item definition publication date\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The citation publication date\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The concept map publication date\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The condition definition publication date\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The event definition publication date\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The evidence publication date\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The evidence variable publication date\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The example scenario publication date\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The implementation guide publication date\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The library publication date\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The measure publication date\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The operation definition publication date\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The plan definition publication date\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The questionnaire publication date\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The requirements publication date\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The structure map publication date\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Date status first applied\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The test script publication date\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The value set publication date\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: successor
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and value assigned to the activity definition\r\n*\
\ [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A use\
\ context type and value assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and value assigned to the charge item definition\r\n\
* [Citation](https://hl7.org/fhir/R5/citation.html): A use context type\
\ and value assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context type and value assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A use context type\
\ and value assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and value assigned to the condition definition\r\n\
* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A use\
\ context type and value assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and value assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and value assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and value assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and value assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): A use context type and\
\ value assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context type and value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and value assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A use context\
\ type and value assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and value assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and value assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and value assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A use context\
\ type and value assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A use context\
\ type and value assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context type and value assigned to the value set\r\n"
required: false
schema:
type: string
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Intended jurisdiction for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Intended jurisdiction for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Intended jurisdiction for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Intended jurisdiction for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Intended jurisdiction for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Intended jurisdiction for the event definition\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Intended jurisdiction for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Intended jurisdiction for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Intended jurisdiction for the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Intended jurisdiction for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Intended jurisdiction for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Intended jurisdiction for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Intended jurisdiction for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Intended jurisdiction for the value set\r\n"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The description of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The description of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The description of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The description of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The description of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The description of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The description of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The description of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The description of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The description of the evidence variable\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The description of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The description of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The description of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The description of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The description of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The description of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The description of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The description of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The description of the value set\r\n"
required: false
schema:
type: string
- name: derived-from
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A resource that the CodeSystem is derived from\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A resource that the ConceptMap is derived from\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A resource that the NamingSystem is derived from\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A resource that the ValueSet is derived from\r\n"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A type of use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A type of use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A type of use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A type of use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A type of use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A type of use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A type of use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A type of use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A type of use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A type of use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A type of use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A type of use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A type of use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A type of use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A type of use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A type of use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A type of use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: predecessor
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The predecessor of the CodeSystem\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The predecessor of the ConceptMap\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The predecessor of the NamingSystem\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The predecessor of the ValueSet\r\n"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The human-friendly name of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The human-friendly name of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The human-friendly name of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The human-friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The human-friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The human-friendly name of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The human-friendly name of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The human-friendly name of the evidence variable\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The human-friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The human-friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Human-friendly name of the ObservationDefinition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The human-friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The human-friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The human-friendly name of the requirements\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Human-friendly name of the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The human-friendly name of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Name for this SubscriptionTopic (Human friendly)\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The human-friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The human-friendly name of the value set\r\n"
required: false
schema:
type: string
- name: composed-of
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A quantity- or range-valued use context assigned to the activity definition\r\
\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A quantity-\
\ or range-valued use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A quantity- or range-valued use context assigned to the charge item definition\r\
\n* [Citation](https://hl7.org/fhir/R5/citation.html): A quantity- or range-valued\
\ use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A quantity- or range-valued use context assigned to the code system\r\n\
* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A quantity- or\
\ range-valued use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A quantity- or range-valued use context assigned to the condition definition\r\
\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A quantity-\
\ or range-valued use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A quantity- or range-valued use context assigned to the evidence\r\n*\
\ [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html): A quantity-\
\ or range-valued use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A quantity- or range-valued use context assigned to the evidence variable\r\
\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html): A quantity-\
\ or range-valued use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A quantity- or range-valued use context assigned to the implementation\
\ guide\r\n* [Library](https://hl7.org/fhir/R5/library.html): A quantity-\
\ or range-valued use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A quantity- or range-valued use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html): A quantity-\
\ or range-valued use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A quantity-\
\ or range-valued use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A quantity- or range-valued use context assigned to the questionnaire\r\
\n* [Requirements](https://hl7.org/fhir/R5/requirements.html): A quantity-\
\ or range-valued use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A quantity- or range-valued use context assigned to the search parameter\r\
\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A quantity-\
\ or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A quantity- or\
\ range-valued use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A quantity- or range-valued use context assigned to the value set\r\n"
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: effective
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The time during which the activity definition is intended to be in use\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The time during which the charge item definition is intended to be in\
\ use\r\n* [Citation](https://hl7.org/fhir/R5/citation.html): The time during\
\ which the citation is intended to be in use\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The time during which the CodeSystem is intended to be in use\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The time during which the ConceptMap is intended to be in use\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The time during which the event definition is intended to be in use\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): The time during which\
\ the library is intended to be in use\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The time during which the measure is intended to be in use\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The time during which the NamingSystem is intended to be in use\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The time during which the plan definition is intended to be in use\r\n\
* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html): The time\
\ during which the questionnaire is intended to be in use\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The time during which the ValueSet is intended to be in use\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html): A\
\ use context type and quantity- or range-based value assigned to the code\
\ system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html): A use context\
\ type and quantity- or range-based value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html): A\
\ use context type and quantity- or range-based value assigned to the value\
\ set\r\n"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ External identifier for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ External identifier for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ External identifier for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ External identifier for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ External identifier for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ External identifier for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ External identifier for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ External identifier for the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ External identifier for the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ External identifier for the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ External identifier for the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ External identifier for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ External identifier for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ External identifier for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ External identifier for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ External identifier for the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ Business identifier for this medication\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ External identifier for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ External identifier for the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The unique identifier associated with the specimen definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ External identifier for the search parameter\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ External identifier for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ External identifier for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ External identifier for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ External identifier for the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The unique identifier associated with the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ External identifier for the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business Identifier for SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ External identifier for the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ An identifier for the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ External identifier for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ External identifier for the value set\r\n"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The business version of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The business version of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The business version of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The business version of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The business version of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The business version of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The business version of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The business version of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The business version of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The business version of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The business version of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The business version of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The business version of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The business version of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The business version of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The business version of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The business version of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The business version of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The business version of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The business version of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The business version of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business version of the SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The business version of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The business version of the value set\r\n"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The uri that identifies the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The uri that identifies the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The uri that identifies the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The uri that identifies the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The URI that identifies the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The uri that identifies the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The uri that identifies the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The uri that identifies the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The uri that identifies the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The uri that identifies the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The uri that identifies the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The uri that identifies the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The uri that identifies the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The uri that identifies the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The uri that identifies the observation definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The uri that identifies the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The uri that identifies the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The uri that identifies the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The uri that identifies the specimen definition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The uri that identifies the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Logical canonical URL to reference this SubscriptionTopic (globally unique)\r\
\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The uri that identifies the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The uri that identifies the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The uri that identifies the value set\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Computationally friendly name of the activity definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Computationally friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Computationally friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Computationally friendly name of the event definition\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Computationally friendly name of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Computationally friendly name of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Computationally friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Computationally friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Computationally friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Computationally friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Computationally friendly name of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Computationally friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Computationally friendly name of the value set\r\n"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Name of the publisher of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Name of the publisher of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Name of the publisher of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Name of the publisher of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Name of the publisher of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Name of the publisher of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ Name of the publisher of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ Name of the publisher of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Name of the publisher of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Name of the publisher of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Name of the publisher of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Name of the publisher of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Name of the publisher of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Name of the publisher of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Name of the publisher of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Name of the publisher of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Name of the publisher of the value set\r\n"
required: false
schema:
type: string
- name: topic
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Topics associated with the module\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Topics associated with the CodeSystem\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Topics associated with the ConceptMap\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Topics associated with the module\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Topics associated with the EvidenceVariable\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Topics associated with the module\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Topics associated with the measure\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Topics associated with the NamingSystem\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Topics associated with the module\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Topics associated with the ValueSet\r\n"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The current status of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The current status of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The current status of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The current status of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The current status of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The current status of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The current status of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The current status of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The current status of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The current status of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The current status of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The current status of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The current status of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The current status of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The current status of the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ active | inactive | entered-in-error\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The current status of the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Publication status of the ObservationDefinition: draft, active, retired,\
\ unknown\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The current status of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The current status of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The current status of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The current status of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The current status of the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Publication status of the SpecimenDefinition: draft, active, retired,\
\ unknown\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The current status of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ draft | active | retired | unknown\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The current status of the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The current status of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The current status of the value set\r\n"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EventDefinition/_search:
get:
tags:
- EventDefinition
summary: "search-type: Search for EventDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The activity definition publication date\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The Actor Definition publication date\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The capability statement publication date\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The charge item definition publication date\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The citation publication date\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The concept map publication date\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The condition definition publication date\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The event definition publication date\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The evidence publication date\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The evidence variable publication date\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The example scenario publication date\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The implementation guide publication date\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The library publication date\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The measure publication date\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The operation definition publication date\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The plan definition publication date\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The questionnaire publication date\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The requirements publication date\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The structure map publication date\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Date status first applied\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The test script publication date\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The value set publication date\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: successor
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and value assigned to the activity definition\r\n*\
\ [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A use\
\ context type and value assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and value assigned to the charge item definition\r\n\
* [Citation](https://hl7.org/fhir/R5/citation.html): A use context type\
\ and value assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context type and value assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A use context type\
\ and value assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and value assigned to the condition definition\r\n\
* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A use\
\ context type and value assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and value assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and value assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and value assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and value assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): A use context type and\
\ value assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context type and value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and value assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A use context\
\ type and value assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and value assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and value assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and value assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A use context\
\ type and value assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A use context\
\ type and value assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context type and value assigned to the value set\r\n"
required: false
schema:
type: string
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Intended jurisdiction for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Intended jurisdiction for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Intended jurisdiction for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Intended jurisdiction for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Intended jurisdiction for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Intended jurisdiction for the event definition\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Intended jurisdiction for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Intended jurisdiction for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Intended jurisdiction for the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Intended jurisdiction for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Intended jurisdiction for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Intended jurisdiction for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Intended jurisdiction for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Intended jurisdiction for the value set\r\n"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The description of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The description of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The description of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The description of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The description of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The description of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The description of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The description of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The description of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The description of the evidence variable\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The description of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The description of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The description of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The description of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The description of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The description of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The description of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The description of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The description of the value set\r\n"
required: false
schema:
type: string
- name: derived-from
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A resource that the CodeSystem is derived from\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A resource that the ConceptMap is derived from\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A resource that the NamingSystem is derived from\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A resource that the ValueSet is derived from\r\n"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A type of use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A type of use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A type of use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A type of use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A type of use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A type of use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A type of use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A type of use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A type of use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A type of use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A type of use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A type of use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A type of use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A type of use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A type of use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A type of use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A type of use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: predecessor
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The predecessor of the CodeSystem\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The predecessor of the ConceptMap\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The predecessor of the NamingSystem\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The predecessor of the ValueSet\r\n"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The human-friendly name of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The human-friendly name of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The human-friendly name of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The human-friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The human-friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The human-friendly name of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The human-friendly name of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The human-friendly name of the evidence variable\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The human-friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The human-friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Human-friendly name of the ObservationDefinition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The human-friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The human-friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The human-friendly name of the requirements\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Human-friendly name of the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The human-friendly name of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Name for this SubscriptionTopic (Human friendly)\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The human-friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The human-friendly name of the value set\r\n"
required: false
schema:
type: string
- name: composed-of
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A quantity- or range-valued use context assigned to the activity definition\r\
\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A quantity-\
\ or range-valued use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A quantity- or range-valued use context assigned to the charge item definition\r\
\n* [Citation](https://hl7.org/fhir/R5/citation.html): A quantity- or range-valued\
\ use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A quantity- or range-valued use context assigned to the code system\r\n\
* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A quantity- or\
\ range-valued use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A quantity- or range-valued use context assigned to the condition definition\r\
\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A quantity-\
\ or range-valued use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A quantity- or range-valued use context assigned to the evidence\r\n*\
\ [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html): A quantity-\
\ or range-valued use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A quantity- or range-valued use context assigned to the evidence variable\r\
\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html): A quantity-\
\ or range-valued use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A quantity- or range-valued use context assigned to the implementation\
\ guide\r\n* [Library](https://hl7.org/fhir/R5/library.html): A quantity-\
\ or range-valued use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A quantity- or range-valued use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html): A quantity-\
\ or range-valued use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A quantity-\
\ or range-valued use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A quantity- or range-valued use context assigned to the questionnaire\r\
\n* [Requirements](https://hl7.org/fhir/R5/requirements.html): A quantity-\
\ or range-valued use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A quantity- or range-valued use context assigned to the search parameter\r\
\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A quantity-\
\ or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A quantity- or\
\ range-valued use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A quantity- or range-valued use context assigned to the value set\r\n"
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: effective
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The time during which the activity definition is intended to be in use\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The time during which the charge item definition is intended to be in\
\ use\r\n* [Citation](https://hl7.org/fhir/R5/citation.html): The time during\
\ which the citation is intended to be in use\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The time during which the CodeSystem is intended to be in use\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The time during which the ConceptMap is intended to be in use\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The time during which the event definition is intended to be in use\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): The time during which\
\ the library is intended to be in use\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The time during which the measure is intended to be in use\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The time during which the NamingSystem is intended to be in use\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The time during which the plan definition is intended to be in use\r\n\
* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html): The time\
\ during which the questionnaire is intended to be in use\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The time during which the ValueSet is intended to be in use\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html): A\
\ use context type and quantity- or range-based value assigned to the code\
\ system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html): A use context\
\ type and quantity- or range-based value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html): A\
\ use context type and quantity- or range-based value assigned to the value\
\ set\r\n"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ External identifier for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ External identifier for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ External identifier for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ External identifier for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ External identifier for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ External identifier for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ External identifier for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ External identifier for the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ External identifier for the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ External identifier for the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ External identifier for the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ External identifier for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ External identifier for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ External identifier for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ External identifier for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ External identifier for the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ Business identifier for this medication\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ External identifier for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ External identifier for the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The unique identifier associated with the specimen definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ External identifier for the search parameter\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ External identifier for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ External identifier for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ External identifier for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ External identifier for the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The unique identifier associated with the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ External identifier for the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business Identifier for SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ External identifier for the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ An identifier for the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ External identifier for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ External identifier for the value set\r\n"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The business version of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The business version of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The business version of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The business version of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The business version of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The business version of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The business version of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The business version of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The business version of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The business version of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The business version of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The business version of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The business version of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The business version of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The business version of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The business version of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The business version of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The business version of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The business version of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The business version of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The business version of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business version of the SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The business version of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The business version of the value set\r\n"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The uri that identifies the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The uri that identifies the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The uri that identifies the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The uri that identifies the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The URI that identifies the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The uri that identifies the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The uri that identifies the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The uri that identifies the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The uri that identifies the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The uri that identifies the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The uri that identifies the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The uri that identifies the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The uri that identifies the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The uri that identifies the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The uri that identifies the observation definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The uri that identifies the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The uri that identifies the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The uri that identifies the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The uri that identifies the specimen definition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The uri that identifies the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Logical canonical URL to reference this SubscriptionTopic (globally unique)\r\
\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The uri that identifies the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The uri that identifies the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The uri that identifies the value set\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Computationally friendly name of the activity definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Computationally friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Computationally friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Computationally friendly name of the event definition\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Computationally friendly name of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Computationally friendly name of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Computationally friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Computationally friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Computationally friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Computationally friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Computationally friendly name of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Computationally friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Computationally friendly name of the value set\r\n"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Name of the publisher of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Name of the publisher of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Name of the publisher of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Name of the publisher of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Name of the publisher of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Name of the publisher of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ Name of the publisher of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ Name of the publisher of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Name of the publisher of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Name of the publisher of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Name of the publisher of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Name of the publisher of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Name of the publisher of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Name of the publisher of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Name of the publisher of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Name of the publisher of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Name of the publisher of the value set\r\n"
required: false
schema:
type: string
- name: topic
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Topics associated with the module\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Topics associated with the CodeSystem\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Topics associated with the ConceptMap\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Topics associated with the module\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Topics associated with the EvidenceVariable\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Topics associated with the module\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Topics associated with the measure\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Topics associated with the NamingSystem\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Topics associated with the module\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Topics associated with the ValueSet\r\n"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The current status of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The current status of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The current status of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The current status of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The current status of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The current status of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The current status of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The current status of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The current status of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The current status of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The current status of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The current status of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The current status of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The current status of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The current status of the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ active | inactive | entered-in-error\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The current status of the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Publication status of the ObservationDefinition: draft, active, retired,\
\ unknown\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The current status of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The current status of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The current status of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The current status of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The current status of the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Publication status of the SpecimenDefinition: draft, active, retired,\
\ unknown\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The current status of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ draft | active | retired | unknown\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The current status of the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The current status of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The current status of the value set\r\n"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EventDefinition/$validate:
get:
tags:
- EventDefinition
summary: "GET: /EventDefinition/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EventDefinition",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/$validate:
get:
tags:
- EventDefinition
summary: "GET: /EventDefinition/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EventDefinition",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/$hapi.fhir.undo-merge:
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/$meta-delete:
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/$meta-add:
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/$meta:
get:
tags:
- EventDefinition
summary: "GET: /EventDefinition/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/$meta:
get:
tags:
- EventDefinition
summary: "GET: /EventDefinition/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/$hapi.fhir.merge:
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "EventDefinition",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/$expunge:
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/$expunge:
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/$diff:
get:
tags:
- EventDefinition
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EventDefinition
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/$reindex-dryrun:
get:
tags:
- EventDefinition
summary: "GET: /EventDefinition/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/$reindex:
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/$graphql:
get:
tags:
- EventDefinition
summary: "GET: /EventDefinition/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EventDefinition
summary: "POST: /EventDefinition/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "Evidence"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Evidence"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/Evidence:
get:
tags:
- Evidence
summary: "search-type: Search for Evidence instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The activity definition publication date\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The Actor Definition publication date\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The capability statement publication date\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The charge item definition publication date\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The citation publication date\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The concept map publication date\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The condition definition publication date\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The event definition publication date\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The evidence publication date\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The evidence variable publication date\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The example scenario publication date\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The implementation guide publication date\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The library publication date\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The measure publication date\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The operation definition publication date\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The plan definition publication date\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The questionnaire publication date\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The requirements publication date\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The structure map publication date\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Date status first applied\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The test script publication date\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The value set publication date\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ External identifier for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ External identifier for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ External identifier for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ External identifier for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ External identifier for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ External identifier for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ External identifier for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ External identifier for the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ External identifier for the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ External identifier for the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ External identifier for the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ External identifier for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ External identifier for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ External identifier for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ External identifier for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ External identifier for the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ Business identifier for this medication\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ External identifier for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ External identifier for the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The unique identifier associated with the specimen definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ External identifier for the search parameter\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ External identifier for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ External identifier for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ External identifier for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ External identifier for the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The unique identifier associated with the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ External identifier for the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business Identifier for SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ External identifier for the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ An identifier for the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ External identifier for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ External identifier for the value set\r\n"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and value assigned to the activity definition\r\n*\
\ [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A use\
\ context type and value assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and value assigned to the charge item definition\r\n\
* [Citation](https://hl7.org/fhir/R5/citation.html): A use context type\
\ and value assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context type and value assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A use context type\
\ and value assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and value assigned to the condition definition\r\n\
* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A use\
\ context type and value assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and value assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and value assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and value assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and value assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): A use context type and\
\ value assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context type and value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and value assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A use context\
\ type and value assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and value assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and value assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and value assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A use context\
\ type and value assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A use context\
\ type and value assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context type and value assigned to the value set\r\n"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The description of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The description of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The description of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The description of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The description of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The description of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The description of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The description of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The description of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The description of the evidence variable\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The description of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The description of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The description of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The description of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The description of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The description of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The description of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The description of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The description of the value set\r\n"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A type of use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A type of use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A type of use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A type of use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A type of use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A type of use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A type of use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A type of use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A type of use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A type of use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A type of use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A type of use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A type of use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A type of use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A type of use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A type of use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A type of use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The human-friendly name of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The human-friendly name of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The human-friendly name of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The human-friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The human-friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The human-friendly name of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The human-friendly name of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The human-friendly name of the evidence variable\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The human-friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The human-friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Human-friendly name of the ObservationDefinition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The human-friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The human-friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The human-friendly name of the requirements\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Human-friendly name of the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The human-friendly name of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Name for this SubscriptionTopic (Human friendly)\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The human-friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The human-friendly name of the value set\r\n"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The business version of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The business version of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The business version of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The business version of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The business version of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The business version of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The business version of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The business version of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The business version of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The business version of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The business version of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The business version of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The business version of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The business version of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The business version of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The business version of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The business version of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The business version of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The business version of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The business version of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The business version of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business version of the SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The business version of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The business version of the value set\r\n"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The uri that identifies the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The uri that identifies the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The uri that identifies the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The uri that identifies the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The URI that identifies the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The uri that identifies the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The uri that identifies the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The uri that identifies the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The uri that identifies the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The uri that identifies the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The uri that identifies the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The uri that identifies the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The uri that identifies the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The uri that identifies the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The uri that identifies the observation definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The uri that identifies the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The uri that identifies the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The uri that identifies the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The uri that identifies the specimen definition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The uri that identifies the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Logical canonical URL to reference this SubscriptionTopic (globally unique)\r\
\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The uri that identifies the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The uri that identifies the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The uri that identifies the value set\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A quantity- or range-valued use context assigned to the activity definition\r\
\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A quantity-\
\ or range-valued use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A quantity- or range-valued use context assigned to the charge item definition\r\
\n* [Citation](https://hl7.org/fhir/R5/citation.html): A quantity- or range-valued\
\ use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A quantity- or range-valued use context assigned to the code system\r\n\
* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A quantity- or\
\ range-valued use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A quantity- or range-valued use context assigned to the condition definition\r\
\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A quantity-\
\ or range-valued use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A quantity- or range-valued use context assigned to the evidence\r\n*\
\ [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html): A quantity-\
\ or range-valued use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A quantity- or range-valued use context assigned to the evidence variable\r\
\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html): A quantity-\
\ or range-valued use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A quantity- or range-valued use context assigned to the implementation\
\ guide\r\n* [Library](https://hl7.org/fhir/R5/library.html): A quantity-\
\ or range-valued use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A quantity- or range-valued use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html): A quantity-\
\ or range-valued use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A quantity-\
\ or range-valued use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A quantity- or range-valued use context assigned to the questionnaire\r\
\n* [Requirements](https://hl7.org/fhir/R5/requirements.html): A quantity-\
\ or range-valued use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A quantity- or range-valued use context assigned to the search parameter\r\
\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A quantity-\
\ or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A quantity- or\
\ range-valued use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A quantity- or range-valued use context assigned to the value set\r\n"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Name of the publisher of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Name of the publisher of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Name of the publisher of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Name of the publisher of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Name of the publisher of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Name of the publisher of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ Name of the publisher of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ Name of the publisher of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Name of the publisher of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Name of the publisher of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Name of the publisher of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Name of the publisher of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Name of the publisher of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Name of the publisher of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Name of the publisher of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Name of the publisher of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Name of the publisher of the value set\r\n"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html): A\
\ use context type and quantity- or range-based value assigned to the code\
\ system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html): A use context\
\ type and quantity- or range-based value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html): A\
\ use context type and quantity- or range-based value assigned to the value\
\ set\r\n"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The current status of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The current status of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The current status of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The current status of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The current status of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The current status of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The current status of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The current status of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The current status of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The current status of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The current status of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The current status of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The current status of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The current status of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The current status of the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ active | inactive | entered-in-error\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The current status of the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Publication status of the ObservationDefinition: draft, active, retired,\
\ unknown\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The current status of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The current status of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The current status of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The current status of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The current status of the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Publication status of the SpecimenDefinition: draft, active, retired,\
\ unknown\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The current status of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ draft | active | retired | unknown\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The current status of the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The current status of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The current status of the value set\r\n"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/Evidence/_search:
get:
tags:
- Evidence
summary: "search-type: Search for Evidence instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The activity definition publication date\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The Actor Definition publication date\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The capability statement publication date\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The charge item definition publication date\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The citation publication date\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The concept map publication date\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The condition definition publication date\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The event definition publication date\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The evidence publication date\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The evidence variable publication date\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The example scenario publication date\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The implementation guide publication date\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The library publication date\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The measure publication date\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The operation definition publication date\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The plan definition publication date\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The questionnaire publication date\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The requirements publication date\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The structure map publication date\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Date status first applied\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The test script publication date\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The value set publication date\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ External identifier for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ External identifier for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ External identifier for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ External identifier for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ External identifier for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ External identifier for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ External identifier for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ External identifier for the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ External identifier for the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ External identifier for the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ External identifier for the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ External identifier for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ External identifier for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ External identifier for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ External identifier for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ External identifier for the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ Business identifier for this medication\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ External identifier for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ External identifier for the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The unique identifier associated with the specimen definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ External identifier for the search parameter\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ External identifier for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ External identifier for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ External identifier for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ External identifier for the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The unique identifier associated with the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ External identifier for the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business Identifier for SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ External identifier for the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ An identifier for the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ External identifier for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ External identifier for the value set\r\n"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and value assigned to the activity definition\r\n*\
\ [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A use\
\ context type and value assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and value assigned to the charge item definition\r\n\
* [Citation](https://hl7.org/fhir/R5/citation.html): A use context type\
\ and value assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context type and value assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A use context type\
\ and value assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and value assigned to the condition definition\r\n\
* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A use\
\ context type and value assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and value assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and value assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and value assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and value assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): A use context type and\
\ value assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context type and value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and value assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A use context\
\ type and value assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and value assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and value assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and value assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A use context\
\ type and value assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A use context\
\ type and value assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context type and value assigned to the value set\r\n"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The description of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The description of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The description of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The description of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The description of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The description of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The description of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The description of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The description of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The description of the evidence variable\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The description of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The description of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The description of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The description of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The description of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The description of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The description of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The description of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The description of the value set\r\n"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A type of use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A type of use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A type of use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A type of use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A type of use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A type of use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A type of use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A type of use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A type of use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A type of use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A type of use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A type of use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A type of use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A type of use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A type of use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A type of use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A type of use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The human-friendly name of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The human-friendly name of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The human-friendly name of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The human-friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The human-friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The human-friendly name of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The human-friendly name of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The human-friendly name of the evidence variable\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The human-friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The human-friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Human-friendly name of the ObservationDefinition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The human-friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The human-friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The human-friendly name of the requirements\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Human-friendly name of the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The human-friendly name of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Name for this SubscriptionTopic (Human friendly)\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The human-friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The human-friendly name of the value set\r\n"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The business version of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The business version of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The business version of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The business version of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The business version of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The business version of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The business version of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The business version of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The business version of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The business version of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The business version of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The business version of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The business version of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The business version of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The business version of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The business version of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The business version of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The business version of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The business version of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The business version of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The business version of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business version of the SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The business version of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The business version of the value set\r\n"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The uri that identifies the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The uri that identifies the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The uri that identifies the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The uri that identifies the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The URI that identifies the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The uri that identifies the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The uri that identifies the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The uri that identifies the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The uri that identifies the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The uri that identifies the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The uri that identifies the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The uri that identifies the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The uri that identifies the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The uri that identifies the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The uri that identifies the observation definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The uri that identifies the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The uri that identifies the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The uri that identifies the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The uri that identifies the specimen definition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The uri that identifies the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Logical canonical URL to reference this SubscriptionTopic (globally unique)\r\
\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The uri that identifies the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The uri that identifies the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The uri that identifies the value set\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A quantity- or range-valued use context assigned to the activity definition\r\
\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A quantity-\
\ or range-valued use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A quantity- or range-valued use context assigned to the charge item definition\r\
\n* [Citation](https://hl7.org/fhir/R5/citation.html): A quantity- or range-valued\
\ use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A quantity- or range-valued use context assigned to the code system\r\n\
* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A quantity- or\
\ range-valued use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A quantity- or range-valued use context assigned to the condition definition\r\
\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A quantity-\
\ or range-valued use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A quantity- or range-valued use context assigned to the evidence\r\n*\
\ [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html): A quantity-\
\ or range-valued use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A quantity- or range-valued use context assigned to the evidence variable\r\
\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html): A quantity-\
\ or range-valued use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A quantity- or range-valued use context assigned to the implementation\
\ guide\r\n* [Library](https://hl7.org/fhir/R5/library.html): A quantity-\
\ or range-valued use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A quantity- or range-valued use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html): A quantity-\
\ or range-valued use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A quantity-\
\ or range-valued use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A quantity- or range-valued use context assigned to the questionnaire\r\
\n* [Requirements](https://hl7.org/fhir/R5/requirements.html): A quantity-\
\ or range-valued use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A quantity- or range-valued use context assigned to the search parameter\r\
\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A quantity-\
\ or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A quantity- or\
\ range-valued use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A quantity- or range-valued use context assigned to the value set\r\n"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Name of the publisher of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Name of the publisher of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Name of the publisher of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Name of the publisher of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Name of the publisher of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Name of the publisher of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ Name of the publisher of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ Name of the publisher of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Name of the publisher of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Name of the publisher of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Name of the publisher of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Name of the publisher of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Name of the publisher of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Name of the publisher of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Name of the publisher of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Name of the publisher of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Name of the publisher of the value set\r\n"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html): A\
\ use context type and quantity- or range-based value assigned to the code\
\ system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html): A use context\
\ type and quantity- or range-based value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html): A\
\ use context type and quantity- or range-based value assigned to the value\
\ set\r\n"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The current status of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The current status of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The current status of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The current status of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The current status of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The current status of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The current status of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The current status of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The current status of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The current status of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The current status of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The current status of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The current status of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The current status of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The current status of the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ active | inactive | entered-in-error\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The current status of the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Publication status of the ObservationDefinition: draft, active, retired,\
\ unknown\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The current status of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The current status of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The current status of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The current status of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The current status of the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Publication status of the SpecimenDefinition: draft, active, retired,\
\ unknown\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The current status of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ draft | active | retired | unknown\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The current status of the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The current status of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The current status of the value set\r\n"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/Evidence/$validate:
get:
tags:
- Evidence
summary: "GET: /Evidence/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Evidence
summary: "POST: /Evidence/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Evidence",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/$validate:
get:
tags:
- Evidence
summary: "GET: /Evidence/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Evidence
summary: "POST: /Evidence/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Evidence",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/$hapi.fhir.undo-merge:
post:
tags:
- Evidence
summary: "POST: /Evidence/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/$meta-delete:
post:
tags:
- Evidence
summary: "POST: /Evidence/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/$meta-add:
post:
tags:
- Evidence
summary: "POST: /Evidence/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/$meta:
get:
tags:
- Evidence
summary: "GET: /Evidence/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Evidence
summary: "POST: /Evidence/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/$meta:
get:
tags:
- Evidence
summary: "GET: /Evidence/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Evidence
summary: "POST: /Evidence/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/$hapi.fhir.merge:
post:
tags:
- Evidence
summary: "POST: /Evidence/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "Evidence",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/$expunge:
post:
tags:
- Evidence
summary: "POST: /Evidence/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/$expunge:
post:
tags:
- Evidence
summary: "POST: /Evidence/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/$diff:
get:
tags:
- Evidence
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Evidence
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/$reindex-dryrun:
get:
tags:
- Evidence
summary: "GET: /Evidence/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Evidence
summary: "POST: /Evidence/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/$reindex:
post:
tags:
- Evidence
summary: "POST: /Evidence/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/$graphql:
get:
tags:
- Evidence
summary: "GET: /Evidence/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Evidence
summary: "POST: /Evidence/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "EvidenceReport"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "EvidenceReport"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EvidenceReport:
get:
tags:
- EvidenceReport
summary: "search-type: Search for EvidenceReport instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ External identifier for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ External identifier for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ External identifier for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ External identifier for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ External identifier for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ External identifier for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ External identifier for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ External identifier for the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ External identifier for the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ External identifier for the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ External identifier for the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ External identifier for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ External identifier for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ External identifier for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ External identifier for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ External identifier for the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ Business identifier for this medication\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ External identifier for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ External identifier for the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The unique identifier associated with the specimen definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ External identifier for the search parameter\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ External identifier for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ External identifier for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ External identifier for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ External identifier for the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The unique identifier associated with the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ External identifier for the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business Identifier for SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ External identifier for the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ An identifier for the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ External identifier for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ External identifier for the value set\r\n"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and value assigned to the activity definition\r\n*\
\ [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A use\
\ context type and value assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and value assigned to the charge item definition\r\n\
* [Citation](https://hl7.org/fhir/R5/citation.html): A use context type\
\ and value assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context type and value assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A use context type\
\ and value assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and value assigned to the condition definition\r\n\
* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A use\
\ context type and value assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and value assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and value assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and value assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and value assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): A use context type and\
\ value assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context type and value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and value assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A use context\
\ type and value assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and value assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and value assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and value assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A use context\
\ type and value assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A use context\
\ type and value assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context type and value assigned to the value set\r\n"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A type of use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A type of use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A type of use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A type of use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A type of use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A type of use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A type of use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A type of use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A type of use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A type of use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A type of use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A type of use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A type of use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A type of use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A type of use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A type of use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A type of use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The uri that identifies the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The uri that identifies the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The uri that identifies the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The uri that identifies the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The URI that identifies the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The uri that identifies the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The uri that identifies the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The uri that identifies the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The uri that identifies the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The uri that identifies the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The uri that identifies the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The uri that identifies the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The uri that identifies the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The uri that identifies the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The uri that identifies the observation definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The uri that identifies the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The uri that identifies the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The uri that identifies the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The uri that identifies the specimen definition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The uri that identifies the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Logical canonical URL to reference this SubscriptionTopic (globally unique)\r\
\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The uri that identifies the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The uri that identifies the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The uri that identifies the value set\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A quantity- or range-valued use context assigned to the activity definition\r\
\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A quantity-\
\ or range-valued use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A quantity- or range-valued use context assigned to the charge item definition\r\
\n* [Citation](https://hl7.org/fhir/R5/citation.html): A quantity- or range-valued\
\ use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A quantity- or range-valued use context assigned to the code system\r\n\
* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A quantity- or\
\ range-valued use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A quantity- or range-valued use context assigned to the condition definition\r\
\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A quantity-\
\ or range-valued use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A quantity- or range-valued use context assigned to the evidence\r\n*\
\ [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html): A quantity-\
\ or range-valued use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A quantity- or range-valued use context assigned to the evidence variable\r\
\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html): A quantity-\
\ or range-valued use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A quantity- or range-valued use context assigned to the implementation\
\ guide\r\n* [Library](https://hl7.org/fhir/R5/library.html): A quantity-\
\ or range-valued use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A quantity- or range-valued use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html): A quantity-\
\ or range-valued use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A quantity-\
\ or range-valued use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A quantity- or range-valued use context assigned to the questionnaire\r\
\n* [Requirements](https://hl7.org/fhir/R5/requirements.html): A quantity-\
\ or range-valued use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A quantity- or range-valued use context assigned to the search parameter\r\
\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A quantity-\
\ or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A quantity- or\
\ range-valued use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A quantity- or range-valued use context assigned to the value set\r\n"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Name of the publisher of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Name of the publisher of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Name of the publisher of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Name of the publisher of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Name of the publisher of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Name of the publisher of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ Name of the publisher of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ Name of the publisher of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Name of the publisher of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Name of the publisher of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Name of the publisher of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Name of the publisher of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Name of the publisher of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Name of the publisher of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Name of the publisher of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Name of the publisher of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Name of the publisher of the value set\r\n"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html): A\
\ use context type and quantity- or range-based value assigned to the code\
\ system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html): A use context\
\ type and quantity- or range-based value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html): A\
\ use context type and quantity- or range-based value assigned to the value\
\ set\r\n"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The current status of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The current status of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The current status of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The current status of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The current status of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The current status of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The current status of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The current status of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The current status of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The current status of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The current status of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The current status of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The current status of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The current status of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The current status of the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ active | inactive | entered-in-error\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The current status of the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Publication status of the ObservationDefinition: draft, active, retired,\
\ unknown\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The current status of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The current status of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The current status of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The current status of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The current status of the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Publication status of the SpecimenDefinition: draft, active, retired,\
\ unknown\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The current status of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ draft | active | retired | unknown\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The current status of the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The current status of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The current status of the value set\r\n"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EvidenceReport/_search:
get:
tags:
- EvidenceReport
summary: "search-type: Search for EvidenceReport instances"
description: This is a search type
parameters:
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ External identifier for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ External identifier for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ External identifier for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ External identifier for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ External identifier for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ External identifier for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ External identifier for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ External identifier for the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ External identifier for the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ External identifier for the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ External identifier for the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ External identifier for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ External identifier for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ External identifier for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ External identifier for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ External identifier for the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ Business identifier for this medication\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ External identifier for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ External identifier for the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The unique identifier associated with the specimen definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ External identifier for the search parameter\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ External identifier for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ External identifier for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ External identifier for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ External identifier for the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The unique identifier associated with the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ External identifier for the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business Identifier for SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ External identifier for the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ An identifier for the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ External identifier for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ External identifier for the value set\r\n"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and value assigned to the activity definition\r\n*\
\ [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A use\
\ context type and value assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and value assigned to the charge item definition\r\n\
* [Citation](https://hl7.org/fhir/R5/citation.html): A use context type\
\ and value assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context type and value assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A use context type\
\ and value assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and value assigned to the condition definition\r\n\
* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A use\
\ context type and value assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and value assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and value assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and value assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and value assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): A use context type and\
\ value assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context type and value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and value assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A use context\
\ type and value assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and value assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and value assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and value assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A use context\
\ type and value assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A use context\
\ type and value assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context type and value assigned to the value set\r\n"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A type of use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A type of use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A type of use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A type of use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A type of use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A type of use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A type of use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A type of use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A type of use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A type of use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A type of use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A type of use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A type of use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A type of use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A type of use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A type of use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A type of use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The uri that identifies the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The uri that identifies the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The uri that identifies the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The uri that identifies the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The URI that identifies the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The uri that identifies the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The uri that identifies the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The uri that identifies the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The uri that identifies the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The uri that identifies the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The uri that identifies the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The uri that identifies the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The uri that identifies the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The uri that identifies the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The uri that identifies the observation definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The uri that identifies the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The uri that identifies the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The uri that identifies the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The uri that identifies the specimen definition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The uri that identifies the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Logical canonical URL to reference this SubscriptionTopic (globally unique)\r\
\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The uri that identifies the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The uri that identifies the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The uri that identifies the value set\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A quantity- or range-valued use context assigned to the activity definition\r\
\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A quantity-\
\ or range-valued use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A quantity- or range-valued use context assigned to the charge item definition\r\
\n* [Citation](https://hl7.org/fhir/R5/citation.html): A quantity- or range-valued\
\ use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A quantity- or range-valued use context assigned to the code system\r\n\
* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A quantity- or\
\ range-valued use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A quantity- or range-valued use context assigned to the condition definition\r\
\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A quantity-\
\ or range-valued use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A quantity- or range-valued use context assigned to the evidence\r\n*\
\ [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html): A quantity-\
\ or range-valued use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A quantity- or range-valued use context assigned to the evidence variable\r\
\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html): A quantity-\
\ or range-valued use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A quantity- or range-valued use context assigned to the implementation\
\ guide\r\n* [Library](https://hl7.org/fhir/R5/library.html): A quantity-\
\ or range-valued use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A quantity- or range-valued use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html): A quantity-\
\ or range-valued use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A quantity-\
\ or range-valued use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A quantity- or range-valued use context assigned to the questionnaire\r\
\n* [Requirements](https://hl7.org/fhir/R5/requirements.html): A quantity-\
\ or range-valued use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A quantity- or range-valued use context assigned to the search parameter\r\
\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A quantity-\
\ or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A quantity- or\
\ range-valued use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A quantity- or range-valued use context assigned to the value set\r\n"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Name of the publisher of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Name of the publisher of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Name of the publisher of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Name of the publisher of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Name of the publisher of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Name of the publisher of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ Name of the publisher of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ Name of the publisher of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Name of the publisher of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Name of the publisher of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Name of the publisher of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Name of the publisher of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Name of the publisher of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Name of the publisher of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Name of the publisher of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Name of the publisher of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Name of the publisher of the value set\r\n"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html): A\
\ use context type and quantity- or range-based value assigned to the code\
\ system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html): A use context\
\ type and quantity- or range-based value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html): A\
\ use context type and quantity- or range-based value assigned to the value\
\ set\r\n"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The current status of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The current status of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The current status of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The current status of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The current status of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The current status of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The current status of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The current status of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The current status of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The current status of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The current status of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The current status of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The current status of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The current status of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The current status of the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ active | inactive | entered-in-error\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The current status of the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Publication status of the ObservationDefinition: draft, active, retired,\
\ unknown\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The current status of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The current status of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The current status of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The current status of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The current status of the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Publication status of the SpecimenDefinition: draft, active, retired,\
\ unknown\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The current status of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ draft | active | retired | unknown\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The current status of the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The current status of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The current status of the value set\r\n"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EvidenceReport/$validate:
get:
tags:
- EvidenceReport
summary: "GET: /EvidenceReport/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource"
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/{id}/$validate:
get:
tags:
- EvidenceReport
summary: "GET: /EvidenceReport/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource"
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/$hapi.fhir.undo-merge:
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/{id}/$meta-delete:
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/{id}/$meta-add:
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/$meta:
get:
tags:
- EvidenceReport
summary: "GET: /EvidenceReport/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/{id}/$meta:
get:
tags:
- EvidenceReport
summary: "GET: /EvidenceReport/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/$hapi.fhir.merge:
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource"
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/$expunge:
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/{id}/$expunge:
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/{id}/$diff:
get:
tags:
- EvidenceReport
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceReport
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/{id}/$reindex-dryrun:
get:
tags:
- EvidenceReport
summary: "GET: /EvidenceReport/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: code
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/{id}/$reindex-dryrun"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/{id}/$reindex:
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/{id}/$reindex"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
}, {
"name": "correctCurrentVersion",
"valueCode": "example"
}, {
"name": "batchSize",
"valueInteger": 0
}, {
"name": "partitionId",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceReport/{id}/$graphql:
get:
tags:
- EvidenceReport
summary: "GET: /EvidenceReport/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceReport
summary: "POST: /EvidenceReport/{id}/$graphql"
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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"
example: |-
{
"resourceType": "EvidenceVariable"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "EvidenceVariable"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EvidenceVariable:
get:
tags:
- EvidenceVariable
summary: "search-type: Search for EvidenceVariable instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The activity definition publication date\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The Actor Definition publication date\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The capability statement publication date\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The charge item definition publication date\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The citation publication date\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The concept map publication date\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The condition definition publication date\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The event definition publication date\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The evidence publication date\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The evidence variable publication date\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The example scenario publication date\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The implementation guide publication date\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The library publication date\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The measure publication date\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The operation definition publication date\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The plan definition publication date\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The questionnaire publication date\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The requirements publication date\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The structure map publication date\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Date status first applied\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The test script publication date\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The value set publication date\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: successor
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and value assigned to the activity definition\r\n*\
\ [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A use\
\ context type and value assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and value assigned to the charge item definition\r\n\
* [Citation](https://hl7.org/fhir/R5/citation.html): A use context type\
\ and value assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context type and value assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A use context type\
\ and value assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and value assigned to the condition definition\r\n\
* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A use\
\ context type and value assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and value assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and value assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and value assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and value assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): A use context type and\
\ value assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context type and value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and value assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A use context\
\ type and value assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and value assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and value assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and value assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A use context\
\ type and value assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A use context\
\ type and value assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context type and value assigned to the value set\r\n"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The description of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The description of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The description of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The description of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The description of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The description of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The description of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The description of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The description of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The description of the evidence variable\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The description of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The description of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The description of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The description of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The description of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The description of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The description of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The description of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The description of the value set\r\n"
required: false
schema:
type: string
- name: derived-from
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A resource that the CodeSystem is derived from\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A resource that the ConceptMap is derived from\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A resource that the NamingSystem is derived from\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A resource that the ValueSet is derived from\r\n"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A type of use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A type of use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A type of use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A type of use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A type of use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A type of use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A type of use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A type of use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A type of use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A type of use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A type of use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A type of use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A type of use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A type of use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A type of use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A type of use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A type of use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: predecessor
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The predecessor of the CodeSystem\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The predecessor of the ConceptMap\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The predecessor of the NamingSystem\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The predecessor of the ValueSet\r\n"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The human-friendly name of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The human-friendly name of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The human-friendly name of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The human-friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The human-friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The human-friendly name of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The human-friendly name of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The human-friendly name of the evidence variable\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The human-friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The human-friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Human-friendly name of the ObservationDefinition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The human-friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The human-friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The human-friendly name of the requirements\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Human-friendly name of the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The human-friendly name of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Name for this SubscriptionTopic (Human friendly)\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The human-friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The human-friendly name of the value set\r\n"
required: false
schema:
type: string
- name: composed-of
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A quantity- or range-valued use context assigned to the activity definition\r\
\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A quantity-\
\ or range-valued use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A quantity- or range-valued use context assigned to the charge item definition\r\
\n* [Citation](https://hl7.org/fhir/R5/citation.html): A quantity- or range-valued\
\ use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A quantity- or range-valued use context assigned to the code system\r\n\
* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A quantity- or\
\ range-valued use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A quantity- or range-valued use context assigned to the condition definition\r\
\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A quantity-\
\ or range-valued use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A quantity- or range-valued use context assigned to the evidence\r\n*\
\ [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html): A quantity-\
\ or range-valued use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A quantity- or range-valued use context assigned to the evidence variable\r\
\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html): A quantity-\
\ or range-valued use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A quantity- or range-valued use context assigned to the implementation\
\ guide\r\n* [Library](https://hl7.org/fhir/R5/library.html): A quantity-\
\ or range-valued use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A quantity- or range-valued use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html): A quantity-\
\ or range-valued use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A quantity-\
\ or range-valued use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A quantity- or range-valued use context assigned to the questionnaire\r\
\n* [Requirements](https://hl7.org/fhir/R5/requirements.html): A quantity-\
\ or range-valued use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A quantity- or range-valued use context assigned to the search parameter\r\
\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A quantity-\
\ or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A quantity- or\
\ range-valued use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A quantity- or range-valued use context assigned to the value set\r\n"
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html): A\
\ use context type and quantity- or range-based value assigned to the code\
\ system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html): A use context\
\ type and quantity- or range-based value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html): A\
\ use context type and quantity- or range-based value assigned to the value\
\ set\r\n"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ External identifier for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ External identifier for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ External identifier for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ External identifier for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ External identifier for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ External identifier for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ External identifier for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ External identifier for the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ External identifier for the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ External identifier for the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ External identifier for the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ External identifier for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ External identifier for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ External identifier for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ External identifier for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ External identifier for the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ Business identifier for this medication\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ External identifier for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ External identifier for the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The unique identifier associated with the specimen definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ External identifier for the search parameter\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ External identifier for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ External identifier for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ External identifier for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ External identifier for the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The unique identifier associated with the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ External identifier for the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business Identifier for SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ External identifier for the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ An identifier for the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ External identifier for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ External identifier for the value set\r\n"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The business version of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The business version of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The business version of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The business version of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The business version of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The business version of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The business version of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The business version of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The business version of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The business version of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The business version of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The business version of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The business version of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The business version of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The business version of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The business version of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The business version of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The business version of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The business version of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The business version of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The business version of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business version of the SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The business version of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The business version of the value set\r\n"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The uri that identifies the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The uri that identifies the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The uri that identifies the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The uri that identifies the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The URI that identifies the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The uri that identifies the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The uri that identifies the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The uri that identifies the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The uri that identifies the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The uri that identifies the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The uri that identifies the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The uri that identifies the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The uri that identifies the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The uri that identifies the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The uri that identifies the observation definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The uri that identifies the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The uri that identifies the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The uri that identifies the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The uri that identifies the specimen definition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The uri that identifies the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Logical canonical URL to reference this SubscriptionTopic (globally unique)\r\
\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The uri that identifies the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The uri that identifies the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The uri that identifies the value set\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Computationally friendly name of the activity definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Computationally friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Computationally friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Computationally friendly name of the event definition\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Computationally friendly name of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Computationally friendly name of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Computationally friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Computationally friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Computationally friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Computationally friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Computationally friendly name of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Computationally friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Computationally friendly name of the value set\r\n"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Name of the publisher of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Name of the publisher of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Name of the publisher of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Name of the publisher of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Name of the publisher of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Name of the publisher of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ Name of the publisher of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ Name of the publisher of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Name of the publisher of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Name of the publisher of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Name of the publisher of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Name of the publisher of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Name of the publisher of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Name of the publisher of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Name of the publisher of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Name of the publisher of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Name of the publisher of the value set\r\n"
required: false
schema:
type: string
- name: topic
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Topics associated with the module\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Topics associated with the CodeSystem\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Topics associated with the ConceptMap\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Topics associated with the module\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Topics associated with the EvidenceVariable\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Topics associated with the module\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Topics associated with the measure\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Topics associated with the NamingSystem\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Topics associated with the module\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Topics associated with the ValueSet\r\n"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The current status of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The current status of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The current status of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The current status of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The current status of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The current status of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The current status of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The current status of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The current status of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The current status of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The current status of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The current status of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The current status of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The current status of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The current status of the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ active | inactive | entered-in-error\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The current status of the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Publication status of the ObservationDefinition: draft, active, retired,\
\ unknown\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The current status of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The current status of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The current status of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The current status of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The current status of the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Publication status of the SpecimenDefinition: draft, active, retired,\
\ unknown\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The current status of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ draft | active | retired | unknown\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The current status of the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The current status of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The current status of the value set\r\n"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/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"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EvidenceVariable/_search:
get:
tags:
- EvidenceVariable
summary: "search-type: Search for EvidenceVariable instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The activity definition publication date\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The Actor Definition publication date\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The capability statement publication date\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The charge item definition publication date\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The citation publication date\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The concept map publication date\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The condition definition publication date\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The event definition publication date\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The evidence publication date\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The evidence variable publication date\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The example scenario publication date\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The implementation guide publication date\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The library publication date\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The measure publication date\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The operation definition publication date\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The plan definition publication date\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The questionnaire publication date\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The requirements publication date\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The structure map publication date\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Date status first applied\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The test script publication date\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The value set publication date\r\n"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _language
in: query
description: Language of the resource content
required: false
schema:
type: string
- name: successor
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and value assigned to the activity definition\r\n*\
\ [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A use\
\ context type and value assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and value assigned to the charge item definition\r\n\
* [Citation](https://hl7.org/fhir/R5/citation.html): A use context type\
\ and value assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context type and value assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A use context type\
\ and value assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and value assigned to the condition definition\r\n\
* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A use\
\ context type and value assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and value assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and value assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and value assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and value assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [Library](https://hl7.org/fhir/R5/library.html): A use context type and\
\ value assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context type and value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and value assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A use context\
\ type and value assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and value assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and value assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and value assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A use context\
\ type and value assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A use context\
\ type and value assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context type and value assigned to the value set\r\n"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The description of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The description of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The description of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The description of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The description of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The description of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The description of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The description of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The description of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The description of the evidence variable\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The description of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The description of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The description of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The description of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The description of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The description of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The description of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The description of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The description of the value set\r\n"
required: false
schema:
type: string
- name: derived-from
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A resource that the CodeSystem is derived from\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A resource that the ConceptMap is derived from\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A resource that the NamingSystem is derived from\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A resource that the ValueSet is derived from\r\n"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A type of use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A type of use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A type of use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A type of use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A type of use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A type of use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A type of use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A type of use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A type of use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A type of use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A type of use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A type of use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A type of use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A type of use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A type of use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A type of use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A type of use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: predecessor
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The predecessor of the CodeSystem\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The predecessor of the ConceptMap\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The predecessor of the NamingSystem\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The predecessor of the ValueSet\r\n"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The human-friendly name of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The human-friendly name of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The human-friendly name of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The human-friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The human-friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The human-friendly name of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The human-friendly name of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The human-friendly name of the evidence variable\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The human-friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The human-friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Human-friendly name of the ObservationDefinition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The human-friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The human-friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The human-friendly name of the requirements\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Human-friendly name of the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The human-friendly name of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Name for this SubscriptionTopic (Human friendly)\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The human-friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The human-friendly name of the value set\r\n"
required: false
schema:
type: string
- name: composed-of
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A quantity- or range-valued use context assigned to the activity definition\r\
\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html): A quantity-\
\ or range-valued use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A quantity- or range-valued use context assigned to the charge item definition\r\
\n* [Citation](https://hl7.org/fhir/R5/citation.html): A quantity- or range-valued\
\ use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A quantity- or range-valued use context assigned to the code system\r\n\
* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html): A quantity- or\
\ range-valued use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A quantity- or range-valued use context assigned to the condition definition\r\
\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html): A quantity-\
\ or range-valued use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A quantity- or range-valued use context assigned to the evidence\r\n*\
\ [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html): A quantity-\
\ or range-valued use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A quantity- or range-valued use context assigned to the evidence variable\r\
\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html): A quantity-\
\ or range-valued use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A quantity- or range-valued use context assigned to the implementation\
\ guide\r\n* [Library](https://hl7.org/fhir/R5/library.html): A quantity-\
\ or range-valued use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A quantity- or range-valued use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html): A quantity-\
\ or range-valued use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html): A quantity-\
\ or range-valued use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A quantity- or range-valued use context assigned to the questionnaire\r\
\n* [Requirements](https://hl7.org/fhir/R5/requirements.html): A quantity-\
\ or range-valued use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A quantity- or range-valued use context assigned to the search parameter\r\
\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html): A quantity-\
\ or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [TestScript](https://hl7.org/fhir/R5/testscript.html): A quantity- or\
\ range-valued use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A quantity- or range-valued use context assigned to the value set\r\n"
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ What resource is being referenced\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ What resource is being referenced\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ What resource is being referenced\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ What resource is being referenced\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ What resource is being referenced\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ What resource is being referenced\r\n"
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context assigned to the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context assigned to the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context assigned to the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context assigned to the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context assigned to the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context assigned to the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context assigned to the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context assigned to the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context assigned to the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context assigned to the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context assigned to the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context assigned to the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ A use context assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context assigned to the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context assigned to the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context assigned to the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context assigned to the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ A use context assigned to the value set\r\n"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html): A\
\ use context type and quantity- or range-based value assigned to the code\
\ system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html): A use context\
\ type and quantity- or range-based value assigned to the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html): A\
\ use context type and quantity- or range-based value assigned to the value\
\ set\r\n"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ External identifier for the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ External identifier for the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ External identifier for the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ External identifier for the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ External identifier for the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ External identifier for the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ External identifier for the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ External identifier for the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ External identifier for the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ External identifier for the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ External identifier for the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ External identifier for the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ External identifier for the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ External identifier for the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ External identifier for the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ External identifier for the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ Business identifier for this medication\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ External identifier for the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ External identifier for the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The unique identifier associated with the specimen definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ External identifier for the search parameter\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ External identifier for the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ External identifier for the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ External identifier for the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ External identifier for the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The unique identifier associated with the SpecimenDefinition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ External identifier for the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business Identifier for SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ External identifier for the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ An identifier for the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ External identifier for the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ External identifier for the value set\r\n"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The business version of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The business version of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The business version of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The business version of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The business version of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The business version of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The business version of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The business version of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The business version of the evidence\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The business version of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The business version of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The business version of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The business version of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The business version of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The business version of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The business version of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The business version of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The business version of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The business version of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The business version of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The business version of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Business version of the SubscriptionTopic\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The business version of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The business version of the value set\r\n"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The uri that identifies the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The uri that identifies the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The uri that identifies the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The uri that identifies the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The URI that identifies the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The uri that identifies the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The uri that identifies the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The uri that identifies the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The uri that identifies the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The uri that identifies the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The uri that identifies the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The uri that identifies the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The uri that identifies the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The uri that identifies the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ The uri that identifies the observation definition\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The uri that identifies the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The uri that identifies the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The uri that identifies the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ The uri that identifies the specimen definition\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The uri that identifies the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ Logical canonical URL to reference this SubscriptionTopic (globally unique)\r\
\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The uri that identifies the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The uri that identifies the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The uri that identifies the value set\r\n"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Computationally friendly name of the activity definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Computationally friendly name of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Computationally friendly name of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Computationally friendly name of the event definition\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Computationally friendly name of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Computationally friendly name of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Computationally friendly name of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Computationally friendly name of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Computationally friendly name of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Computationally friendly name of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Computationally friendly name of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Computationally friendly name of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Computationally friendly name of the value set\r\n"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Name of the publisher of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ Name of the publisher of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ Name of the publisher of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ Name of the publisher of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ Name of the publisher of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Name of the publisher of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ Name of the publisher of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ Name of the publisher of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Name of the publisher of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ Name of the publisher of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Name of the publisher of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Name of the publisher of the measure\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Name of the publisher of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ Name of the publisher of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ Name of the publisher of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ Name of the publisher of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Name of the publisher of the value set\r\n"
required: false
schema:
type: string
- name: topic
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ Topics associated with the module\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ Topics associated with the CodeSystem\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ Topics associated with the ConceptMap\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ Topics associated with the module\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ Topics associated with the EvidenceVariable\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ Topics associated with the module\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ Topics associated with the measure\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ Topics associated with the NamingSystem\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ Topics associated with the module\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ Topics associated with the ValueSet\r\n"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [ActivityDefinition](https://hl7.org/fhir/R5/activitydefinition.html):\
\ The current status of the activity definition\r\n* [ActorDefinition](https://hl7.org/fhir/R5/actordefinition.html):\
\ The current status of the Actor Definition\r\n* [CapabilityStatement](https://hl7.org/fhir/R5/capabilitystatement.html):\
\ The current status of the capability statement\r\n* [ChargeItemDefinition](https://hl7.org/fhir/R5/chargeitemdefinition.html):\
\ The current status of the charge item definition\r\n* [Citation](https://hl7.org/fhir/R5/citation.html):\
\ The current status of the citation\r\n* [CodeSystem](https://hl7.org/fhir/R5/codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](https://hl7.org/fhir/R5/compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](https://hl7.org/fhir/R5/conceptmap.html):\
\ The current status of the concept map\r\n* [ConditionDefinition](https://hl7.org/fhir/R5/conditiondefinition.html):\
\ The current status of the condition definition\r\n* [EventDefinition](https://hl7.org/fhir/R5/eventdefinition.html):\
\ The current status of the event definition\r\n* [Evidence](https://hl7.org/fhir/R5/evidence.html):\
\ The current status of the evidence\r\n* [EvidenceReport](https://hl7.org/fhir/R5/evidencereport.html):\
\ The current status of the evidence report\r\n* [EvidenceVariable](https://hl7.org/fhir/R5/evidencevariable.html):\
\ The current status of the evidence variable\r\n* [ExampleScenario](https://hl7.org/fhir/R5/examplescenario.html):\
\ The current status of the example scenario\r\n* [GraphDefinition](https://hl7.org/fhir/R5/graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](https://hl7.org/fhir/R5/implementationguide.html):\
\ The current status of the implementation guide\r\n* [Library](https://hl7.org/fhir/R5/library.html):\
\ The current status of the library\r\n* [Measure](https://hl7.org/fhir/R5/measure.html):\
\ The current status of the measure\r\n* [MedicationKnowledge](https://hl7.org/fhir/R5/medicationknowledge.html):\
\ active | inactive | entered-in-error\r\n* [MessageDefinition](https://hl7.org/fhir/R5/messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](https://hl7.org/fhir/R5/namingsystem.html):\
\ The current status of the naming system\r\n* [ObservationDefinition](https://hl7.org/fhir/R5/observationdefinition.html):\
\ Publication status of the ObservationDefinition: draft, active, retired,\
\ unknown\r\n* [OperationDefinition](https://hl7.org/fhir/R5/operationdefinition.html):\
\ The current status of the operation definition\r\n* [PlanDefinition](https://hl7.org/fhir/R5/plandefinition.html):\
\ The current status of the plan definition\r\n* [Questionnaire](https://hl7.org/fhir/R5/questionnaire.html):\
\ The current status of the questionnaire\r\n* [Requirements](https://hl7.org/fhir/R5/requirements.html):\
\ The current status of the requirements\r\n* [SearchParameter](https://hl7.org/fhir/R5/searchparameter.html):\
\ The current status of the search parameter\r\n* [SpecimenDefinition](https://hl7.org/fhir/R5/specimendefinition.html):\
\ Publication status of the SpecimenDefinition: draft, active, retired,\
\ unknown\r\n* [StructureDefinition](https://hl7.org/fhir/R5/structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](https://hl7.org/fhir/R5/structuremap.html):\
\ The current status of the structure map\r\n* [SubscriptionTopic](https://hl7.org/fhir/R5/subscriptiontopic.html):\
\ draft | active | retired | unknown\r\n* [TerminologyCapabilities](https://hl7.org/fhir/R5/terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [TestPlan](https://hl7.org/fhir/R5/testplan.html):\
\ The current status of the test plan\r\n* [TestScript](https://hl7.org/fhir/R5/testscript.html):\
\ The current status of the test script\r\n* [ValueSet](https://hl7.org/fhir/R5/valueset.html):\
\ The current status of the value set\r\n"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/EvidenceVariable/$validate:
get:
tags:
- EvidenceVariable
summary: "GET: /EvidenceVariable/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EvidenceVariable",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/{id}/$validate:
get:
tags:
- EvidenceVariable
summary: "GET: /EvidenceVariable/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EvidenceVariable",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/$hapi.fhir.undo-merge:
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/$hapi.fhir.undo-merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/{id}/$meta-delete:
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/{id}/$meta-add:
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/$meta:
get:
tags:
- EvidenceVariable
summary: "GET: /EvidenceVariable/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/{id}/$meta:
get:
tags:
- EvidenceVariable
summary: "GET: /EvidenceVariable/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/$hapi.fhir.merge:
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/$hapi.fhir.merge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "target-resource",
"valueReference": {
"reference": "example"
}
}, {
"name": "source-resource-identifier"
}, {
"name": "target-resource-identifier"
}, {
"name": "result-resource",
"resource": {
"resourceType": "EvidenceVariable",
"id": "1"
}
}, {
"name": "preview",
"valueBoolean": false
}, {
"name": "delete-source",
"valueBoolean": false
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/$expunge:
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/{id}/$expunge:
post:
tags:
- EvidenceVariable
summary: "POST: /EvidenceVariable/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/{id}/$diff:
get:
tags:
- EvidenceVariable
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from